godotengine/godot-contributing-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-contributing-docs.git synced 2026-02-25 02:34:39 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add a section about PR scope to pull request guidelines.

Browse Source
This commit is contained in:
Lukas Tenbrink
2026-01-27 11:54:38 +01:00
parent e6638742fb
commit 2ef91dd015
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
pull_requests/pull_request_guidelines.rst
View File

@@ -35,6 +35,24 @@ This also applies for libraries that are only linked in the editor.
game engines like Unreal or Unity, nor use their code as inspiration. We strongly recommend against reading any
"source-available" code before contributing to Godot.
Contribute one change at a time
-------------------------------
Each pull request should contain a single self-contained change. Avoid pushing multiple unrelated changes
in the same pull request.
As a rule of thumb, if your pull request could be split into two pull requests without
breaking anything, it should probably be two separate pull requests.
The exception to this rule is "batching changes", where you make the same kind of change to multiple places in
the codebase. In this case, it is preferable to make one larger pull request instead of many small ones.
.. note:: Imagine yourself in the shoes of the reviewer: how can you make the PR easy to review and approve?
This is best achieved if your pull request is simple, coherent, and uncontroversial.
Limiting pull requests to one change at a time also simplifies the Git history, makes it possible to
revert or cherry-pick specific changes, and reduces the potential of accidentally introducing bugs.
Explain your contributions
--------------------------