Skip to content

Commit 6912bc6

Browse files
author
Gary Rennie
committed
docs(CONTRIBUTING.md): add a note about subject tense and case
The contribution guidelines previously did not mention that the commit messages should be lowercase and in the past tense. This has been updated with an example.
1 parent f53dc7a commit 6912bc6

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@ All pull request commit messages are automatically checked using [GitCop](http:/
1818

1919
No line in your commit message shoult be longer than **72** characters. If you have something that is longer than this (such as a url), please put it on to multiple lines with a backspace at the end of each line.
2020

21+
##### Subject
22+
23+
The subject (first commit line) should be written in the past tense and should start with a lower case letter. e.g.
24+
25+
feat(Changex.Formatter): add ability to determine current_version
26+
27+
Instead of:
28+
29+
Feat(Changex.Formatter): Add ability to determine current_version
30+
2131
##### Format
2232

2333
Because Changex automatically generates the [CHANGELOG.md](https://github.com/Gazler/changex/blob/master/CHANGELOG.md) from the commit messages, it is important that the follow these rules.

0 commit comments

Comments
 (0)