148 Commits

Author SHA1 Message Date
snailrhymer
a2e309ecfc Add command to build specific files in Building the manual with Sphinx (#5828) 2022-05-20 22:04:37 +02:00
Eduardo Rodrigues
b479f8884d Fix minor errors on PR workflow page (#5762) 2022-04-13 00:43:42 +02:00
Timon Bestebreur
54423eb588 Fix a typo in Best practices for engine contributors (#5613) 2022-02-16 17:46:22 +01:00
snailrhymer
274d464808 Update IRC links to point to Godot Contributors Chat (#5550)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2022-01-26 01:34:21 +01:00
Rémi Verschelde
1dbbba6dc8 C++ style guide: Require clang-format 13
(cherry picked from commit 154c093f97)
2021-10-25 12:15:27 +02:00
Kate
5993cd3ea0 Fix grammar issue in "Ways to contribute" page
In the section "Filing an issue on GitHub", the subsection "How to reproduce the bug" says "Even if you think that the issue is trivial to reproduce, adding a minimal project that lets reproduce it is a big added value." which is missing a word. Changing it to "...lets everyone reproduce it..." fixes the grammatical error.
2021-10-15 15:31:48 +02:00
Andrii Doroshenko (Xrayez)
e0291515e8 Use "Prefer local solutions" in best practices for engine contributors
Stating that "Solution must be local" is denying the fact that some problems
cannot be solved locally. Therefore, documentation should recommend
contributors to first look at solutions which are closer to the problem first,
and only go for solution that touch core if a problem cannot be solved
locally, for instance.
2021-10-15 15:19:30 +02:00
developer
1c51ddc0a8 Use pip3 instead of pip 2021-08-31 01:13:33 +02:00
Hugo Locurcio
85782a4b00 Update Bug triage guidelines for newly added labels 2021-08-14 17:48:35 +02:00
Hugo Locurcio
d055dc5e14 Backport Building the manual with Sphinx page from the master branch 2021-07-13 00:25:45 +02:00
Hugo Locurcio
13c42efab6 Add a page on testing pull requests
(cherry picked from commit 0d54651250)
2021-06-02 13:19:17 +02:00
Yuri Sizov
1bb400fef4 Add a mention of the PR review process and proposals to the contribution guide (#4801)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-04-01 02:33:37 +02:00
Rémi Verschelde
9eba7649e1 Update copyrights to 2021
(cherry picked from commit 0a087e730f)
2021-03-19 14:02:49 +01:00
Hugo Locurcio
ae0fe2a624 Fix incorrect link in Code style guidelines (#4732)
This caused a Sphinx build failure.
2021-03-08 18:55:02 +01:00
Hugo Locurcio
1dc254ba94 Add a comment style guide for Godot contributions (#4421) 2021-03-03 22:27:30 +01:00
Rémi Verschelde
a16e10538f Merge branch 'master' into 3.2 2020-09-28 15:43:06 +02:00
Nathan Lovato
e5eace98aa Remove article in best_practices_for_engine_contributors.rst 2020-09-27 08:34:20 -06:00
Andrii Doroshenko (Xrayez)
bdec429514 Clarify "The problem has to exist" in the best practices
Simply saying that "The problem has to exist" from the start may convey
a wrong subconscious message that problems must exist in the engine for
the sake of it, especially if taken out of context, so it's better to
make this more explicit to mean that "problems can only be solved when
they actually exist" up front.
2020-09-26 13:52:42 +03:00
Rémi Verschelde
6d8c7b1d1a Merge branch 'master' into 3.2 2020-09-11 09:15:57 +02:00
Pierre Caye
eb52c7330f Fix quote marks 2020-09-10 13:34:16 +02:00
Rémi Verschelde
e337af304f Merge branch 'master' into 3.2 2020-09-09 13:02:26 +02:00
Numan Zaheer Ahmed
fcbe81e0f4 Updated Python Code Style Guidelines (#3828)
Updated Python Code Style Guidelines to use Black now.
2020-09-09 12:38:04 +02:00
Rémi Verschelde
d27279babe Merge pull request #3940 from Calinou/bisecting-regressions-clarify-command
Use a more explicit `git bisect` command in Bisecting regressions
2020-09-09 12:08:19 +02:00
Nathan Lovato
e37ee4239c Merge pull request #3949 from Calinou/class-reference-info-blocks
Add a style guide for informational blocks in the class reference
2020-09-01 17:16:21 -06:00
Hugo Locurcio
b4f9966e8a Add a style guide for informational blocks in the class reference 2020-09-02 01:14:35 +02:00
Hugo Locurcio
9931060f06 Use a more explicit git bisect command in Bisecting regressions
This command makes it possible to specify the good and bad commits
in any order, avoiding issues with specifying commits in the wrong
order.
2020-08-28 11:32:59 +02:00
Hugo Locurcio
0bc5917d43 Mention licensing requirements in Best practices for engine contributors 2020-08-22 18:29:23 +02:00
Nathan Lovato
6e9055f4e8 Edit docs_writing_guidelines
Tweaked some sentences to remove parentheses
Turned the note about pngquant into a note box
2020-08-21 10:34:23 -06:00
Hugo Locurcio
207c2e015d Improve Docs writing guidelines
- Add a return type to the "don't add return type hints" example.
- Update the Node2D brief description to match the current documentation.
- Recommend a colorblind-friendly color for outlines in screenshots.
- Reference Squoosh and OxiPNG in the image compression guidelines.
2020-08-21 15:42:48 +02:00
Rémi Verschelde
76cf11c890 Merge branch 'master' into 3.2 2020-07-30 17:14:54 +02:00
Aaron Franke
69f6893e3f Add an exception for "ing" verbs where the subject is not clear 2020-07-26 14:54:28 -04:00
Rémi Verschelde
ce564cdaeb Merge pull request #3788 from Calinou/best-practices-add-performance-vs-usability
Mention performance/usability in Best practices for engine contributors
2020-07-15 10:04:03 +02:00
Rémi Verschelde
b181d3f07f Fix inner reference to editor/docs localization page
Having a `.. highlight:` tag between the reference and the title it refers to
breaks the index.
2020-07-15 09:46:19 +02:00
Hugo Locurcio
90d9dc28a8 Mention performance/usability in Best practices for engine contributors
This also wraps the text to 80 characters.

See https://github.com/godotengine/godot-proposals/issues/575.
2020-07-14 22:54:26 +02:00
Rémi Verschelde
63dfe53a9d Contributing: Editor and docs localization 2020-07-13 14:12:26 +02:00
Rémi Verschelde
8f6b4a2ace Merge branch 'master' into 3.2 2020-05-27 13:45:21 +02:00
Hugo Locurcio
47b0721d8a Capitalize all instances of Git in the documentation 2020-05-23 18:34:55 +02:00
Alex
d316587774 Update number of developers contributed 2020-05-21 08:20:30 +01:00
Rémi Verschelde
10f20b00cb Merge branch 'master' into 3.2 2020-05-20 15:08:42 +02:00
Hugo Locurcio
4f6fdbc710 Fix various spacing and capitalization issues 2020-05-18 09:54:32 +02:00
Hugo Locurcio
d494d19dac Remove trailing whitespace and irregular whitespace 2020-05-17 00:26:19 +02:00
Hugo Locurcio
df67eeae47 Improve the Contribute to the Class Reference page
- Link to the online class reference completion status page.
- Mention the `[kbd]` tag to display keyboard/mouse shortcuts.
- Improve grammar and writing style a bit.
2020-05-16 16:51:43 +02:00
Rémi Verschelde
5b71adbdcf PR workflow: Improve instructions around updating, amending and rebasing
I was young and careless when documenting `git rebase -i HEAD~2`,
I since found out that it's much cleaner and safer to rebase on
the upstream branch directly.
2020-05-16 00:07:20 +02:00
Rémi Verschelde
0a9fc75dc0 Merge branch 'master' into 3.2 2020-04-27 12:18:11 +02:00
Yuri Sizov
135b33b768 Replace British spelling and fix various typos 2020-04-27 12:18:52 +03:00
Rémi Verschelde
c0cc4698f8 Merge branch 'master' into 3.2 2020-04-27 09:58:35 +02:00
Max Hilbrunner
20dfc7d3c9 Merge pull request #3449 from mhilbrunner/fix-contrib-guide-layout
Fix documentation guidelines to not break layout
2020-04-26 17:51:32 +02:00
Max Hilbrunner
15a8804da6 Fix documentation guidelines to not break layout 2020-04-26 16:53:29 +02:00
Hugo Locurcio
263ff56251 Define the Weblate badge size to avoid reflows during page loading 2020-04-25 21:31:00 +02:00
Rémi Verschelde
997fc68e78 Merge branch 'master' into 3.2 2020-04-17 19:09:14 +02:00