LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Projects Releases 28 Packages Wiki Activity

docs: Clarify model commit message summary

Browse source 
Add a paragraph about prefixing commit message summaries with the
package/subsystem that they're changing to
code_contribution_guidelines.md.
This commit is contained in:
David de Kloet 2016-11-21 10:04:37 +01:00 • committed by Dave Collins
parent e1b2ceca80
commit 34b9721494
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/code_contribution_guidelines.md
View file

@ -228,6 +228,12 @@ Further paragraphs come after blank lines.
- Use a hanging indent - 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 Here are some of the reasons why wrapping your commit messages to 72 columns is
a good thing. a good thing.