@@ -35,6 +35,32 @@ This also applies for libraries that are only linked in the editor.
3535game engines like Unreal or Unity, nor use their code as inspiration. We strongly recommend against reading any
3636"source-available" code before contributing to Godot.
3737
38+ Explain your contributions
39+ --------------------------
40+
41+ When submitting a pull request, please make use of the pull request description.
42+
43+ Your pull request description should be appropriate for the complexity of the change. For example, if you're just fixing
44+ a typo, a single sentence description is appropriate. However, if your change is large, or may affect multiple systems
45+ in potentially unexpected ways, we expect you to be more thorough with your explanation.
46+
47+ Here are the components of a thorough pull request description:
48+
49+ - **Summary of changes: ** A short overview of what is changed.
50+ - **Motivation: ** Why you opened the pull request. Ideally, this is a link to an issue or proposal.
51+ - **Related work: ** Link to similar pull requests or ongoing discussions that provide additional context.
52+ - **Technical overview: ** Briefly explain each of the changes in this pull request, and why there are necessary.
53+ - **Testing: ** How you tested the pull request, and the results of your testing.
54+ - **Discussion: ** How you see the pull request in context. For example, list risks and caveats and how they could be
55+ mitigated. If existing projects may be negatively affected, you should disclose this here, with particular attention
56+ to possible :ref: `compatibility breakages <doc_handling_compatibility_breakages >` and regressions.
57+ - **Additional work: ** If applicable, highlight anything you need help with or feedback on, and describe follow-up
58+ work that could be or needs to be done.
59+
60+ .. note :: You may not need _every_ one of these components, and you do not need to copy this exact structure.
61+ Always ask yourself what would be most helpful for reviewers, and try to balance brevity and thoroughness
62+ appropriately.
63+
3864Contribute only what you understand
3965-----------------------------------
4066
0 commit comments