Skip to content

Commit 4597732

Browse files
committed
docs: add semantic git commit messages
1 parent 1193f5b commit 4597732

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,18 @@ includes code changes) and under the terms of the
163163
[Creative Commons Attribution 3.0 Unported License](docs/LICENSE)
164164
(if it includes documentation changes).
165165

166+
### Semantic Git commit messages
167+
168+
Inspired by Sparkbox's awesome article on [semantic commit messages](http://seesparkbox.com/foundry/semantic_commit_messages). Please use following commit message format.
169+
170+
* chore (updating npm tasks etc; no production code change) -> ```git test -m 'chore: commit-message-here'```
171+
* docs (changes to documentation) -> ```git commit -m 'docs: commit-message-here'```
172+
* feat (new feature) -> ```git commit -m 'feat: commit-message-here'```
173+
* fix (bug fix) -> ```git commit -m 'fix: commit-message-here'```
174+
* refactor (refactoring production code) -> ```git commit -m 'refactor: commit-message-here'```
175+
* style (formatting, missing semi colons, etc; no code change) -> ```git commit -m 'style: commit-message-here'```
176+
* test (adding missing tests, refactoring tests; no production code change) -> ```git test -m 'refactor: commit-message-here'```
177+
166178

167179
## Code guidelines
168180

0 commit comments

Comments
 (0)