From 34b9721494b88f917b4e85e9262a1eb3ec3a7b85 Mon Sep 17 00:00:00 2001 From: David de Kloet Date: Mon, 21 Nov 2016 10:04:37 +0100 Subject: [PATCH] docs: Clarify model commit message summary Add a paragraph about prefixing commit message summaries with the package/subsystem that they're changing to code_contribution_guidelines.md. --- docs/code_contribution_guidelines.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/code_contribution_guidelines.md b/docs/code_contribution_guidelines.md index dbbc71c5..20429452 100644 --- a/docs/code_contribution_guidelines.md +++ b/docs/code_contribution_guidelines.md @@ -228,6 +228,12 @@ Further paragraphs come after blank lines. - Use a hanging indent ``` +Prefix the summary with the subsystem/package when possible. Many other +projects make use of the code and this makes it easier for them to tell when +something they're using has changed. Have a look at [past +commits](https://github.com/btcsuite/btcd/commits/master) for examples of +commit messages. + Here are some of the reasons why wrapping your commit messages to 72 columns is a good thing.