Add Issue Number to Commit Message How-To

Weltraumschaf · Weltraumschaf · commit c6fbe992a94b · 2024-02-02T19:27:54.000+01:00
Signed-off-by: Sven Strittmatter &lt;sven.strittmatter@iteratec.com&gt;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -91,13 +91,14 @@ For more information see [Chris Beams article](https://chris.beams.io/posts/git-
 
 TL;DR
 
-1. Separate subject from body with a blank line
-2. Limit the subject line to 50 characters
-3. Capitalize the subject line
-4. Do not end the subject line with a period
-5. Use the imperative mood in the subject line
-6. Wrap the body at 72 characters
-7. Use the body to explain what and why vs. how
+1. Separate subject from body with a blank line.
+2. Add the issue number at beginning of to the subject line (e.g. "#42 Adds the Answer to the Live, Universe, and the Rest")
+2. Limit the subject line to 50 characters.
+3. Capitalize the subject line.
+4. Do not end the subject line with a period.
+5. Use the imperative mood in the subject line.
+6. Wrap the body at 72 characters.
+7. Use the body to explain what and why (not how because this is obvious from the diff).
 
 **NOTE**: Make sure you don't include `@mentions` or `fixes` keywords in your git commit messages. These should be included in the PR body instead.
 
