summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-06-10 10:32:46 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-06-10 10:36:59 +0200
commit6d0e8f9fb70ff00088185f59a627c8f65f5d78ed (patch)
treea8a0661896e036e61a9bc46d3dc8533217996de1
parentae21b5ddad844b92d055dd77dca5ce84d56b9719 (diff)
Document the requirement to update the class reference when contributing
Documenting new additions has been an informal requirement for a few months now. This makes it official.
-rw-r--r--CONTRIBUTING.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ba04008680..c28692c34f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -119,6 +119,22 @@ for an introduction to developing on Godot.
The [Contributing docs](https://docs.godotengine.org/en/latest/community/contributing/index.html)
also have important information on the PR workflow and the code style we use.
+### Document your changes
+
+If your pull request adds methods, properties or signals that are exposed to
+scripting APIs, you **must** update the class reference to document those.
+This is to ensure the documentation coverage doesn't decrease as contributions
+are merged.
+
+[Update the documentation template](https://docs.godotengine.org/en/latest/community/contributing/updating_the_class_reference.html#updating-the-documentation-template)
+using your compiled binary, then fill in the descriptions.
+Follow the style guide described in the
+[Docs writing guidelines](https://docs.godotengine.org/en/latest/community/contributing/docs_writing_guidelines.html).
+
+If your pull request modifies parts of the code in a non-obvious way, make sure
+to add comments in the code as well. This helps other people understand the
+change without having to look at `git blame`.
+
### Be nice to the Git history
Try to make simple PRs that handle one specific topic. Just like for reporting