From 6f99aeda04c0bce28d9471980912081416981c85 Mon Sep 17 00:00:00 2001
From: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Date: Sat, 22 Jun 2024 15:18:07 +0200
Subject: [PATCH] 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.
---
 CONTRIBUTING.md | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4c76101ebc8..a698343f2af 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -113,10 +113,11 @@ specify the engine area affected by the commit. Some examples:
 - Core: Fix `Object::has_method()` for script static methods
 
 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)
 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
 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,
 this commit now ensures that Godot will not go past the ebullition temperature
 of cooking oil under normal atmospheric conditions.
-
-Fixes #1340.
 ```
 
 **Note:** When using the GitHub online editor or its drag-and-drop