godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Change suggestion in `CONTRIBUTING.md` to avoid spam 

Having an issue tagged in a commit message spams the issue thread with
notifications, which can be especially noisy when new contributors make
a lot of updates or rebases.
This commit is contained in:
A Thousand Ships 2024-06-22 15:18:07 +02:00
parent 8a6c1e8f52
commit 6f99aeda04
No known key found for this signature in database
GPG Key ID: 2033189A662F8BD7
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -113,10 +113,11 @@ specify the engine area affected by the commit. Some examples:
- Core: Fix `Object::has_method()` for script static methods - Core: Fix `Object::has_method()` for script static methods
If your commit fixes a reported issue, please include it in the _description_ If your commit fixes a reported issue, please include it in the _description_
of the commit (not in the title) using one of the of the PR (not in the title, or the commit message) using one of the
[GitHub closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) [GitHub closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
such as "Fixes #1234". This will cause the issue to be closed automatically if such as "Fixes #1234". This will cause the issue to be closed automatically if
the PR is merged. the PR is merged. Adding it to the commit message is easier, but adds a lot of
unnecessary updates in the issue distracting from the thread.
Here's an example of a well-formatted commit message (note how the extended Here's an example of a well-formatted commit message (note how the extended
description is also manually wrapped at 80 chars for readability): description is also manually wrapped at 80 chars for readability):
@ -131,8 +132,6 @@ unwanted side effects in the physics engine.
By fixing the regulation system via an added binding to the internal feature, By fixing the regulation system via an added binding to the internal feature,
this commit now ensures that Godot will not go past the ebullition temperature this commit now ensures that Godot will not go past the ebullition temperature
of cooking oil under normal atmospheric conditions. of cooking oil under normal atmospheric conditions.
Fixes #1340.
``` ```
**Note:** When using the GitHub online editor or its drag-and-drop **Note:** When using the GitHub online editor or its drag-and-drop