From b0972a94c38dd7996b083e8d665e64645337fb73 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Thu, 2 Sep 2021 12:03:08 +0200 Subject: [PATCH] contributing: don't reference issues in commit first line Commits named "Fix #XXX" make it pretty complicated to figure out exactly what the commit is doing from the shortlog. A better place for issue references is in the extended commit message. --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7fb2a6b9..89ebab18 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,8 +76,7 @@ Please strive to write good commit messages. Here's some guidelines to follow: The first line should be limited to 50 characters and should be a sentence that completes the thought [When applied, this commit will...] *"Implement -cmd_move"* or *"Fix #742"* or *"Improve performance of arrange_windows on ARM"* -or similar. +cmd_move"* or *"Improve performance of arrange_windows on ARM"* or similar. The subsequent lines should be separated from the subject line by a single blank line, and include optional details. In this you can give justification