|
| 1 | +# Commit Message Convention |
| 2 | + |
| 3 | +## The reasons for these conventions: |
| 4 | +* automatic generating of the changelog |
| 5 | +* simple navigation through git history (eg. ignoring style changes) |
| 6 | + |
| 7 | +## Format of the commit message: |
| 8 | +``` |
| 9 | +<type>: <subject> |
| 10 | +
|
| 11 | +<body> |
| 12 | +
|
| 13 | +<footer> |
| 14 | +``` |
| 15 | + |
| 16 | +## Message subject (first line) |
| 17 | +First line cannot be longer than 70 characters, second line is always blank and other lines should be wrapped at 80 characters. |
| 18 | + |
| 19 | +### Allowed <type> values: |
| 20 | +* feat (new feature) |
| 21 | +* fix (bug fix) |
| 22 | +* docs (changes to documentation) |
| 23 | +* style (formatting, missing semi colons, etc; no code change) |
| 24 | +* refactor (refactoring production code) |
| 25 | +* test (adding missing tests, refactoring tests; no production code change) |
| 26 | +* chore (updating grunt tasks etc; no production code change) |
| 27 | + |
| 28 | +## Message body |
| 29 | +* uses the imperative, present tense: “change” not “changed” nor “changes” |
| 30 | +* includes motivation for the change and contrasts with previous behavior |
| 31 | + |
| 32 | +For more info about message body, see: |
| 33 | +* http://365git.tumblr.com/post/3308646748/writing-git-commit-messages |
| 34 | +* http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html |
| 35 | + |
| 36 | +## Message footer |
| 37 | +### Referencing issues |
| 38 | +Closed issues should be listed on a separate line in the footer prefixed with "Closes" keyword like this: |
| 39 | +``` |
| 40 | +Closes #234 |
| 41 | +``` |
| 42 | + |
| 43 | +or in case of multiple issues: |
| 44 | + |
| 45 | +``` |
| 46 | +Closes #123, #245, #992 |
| 47 | +``` |
| 48 | + |
| 49 | +## Breaking changes |
| 50 | +All breaking changes have to be mentioned in footer with the description of the change, justification and migration notes. |
| 51 | +``` |
| 52 | +BREAKING CHANGE: |
| 53 | +
|
| 54 | +`port-runner` command line option has changed to `runner-port`, so that it is |
| 55 | +consistent with the configuration file syntax. |
| 56 | +
|
| 57 | +To migrate your project, change all the commands, where you use `--port-runner` |
| 58 | +to `--runner-port`. |
| 59 | +This document is based on AngularJS Git Commit Msg Convention. |
| 60 | +``` |
| 61 | + |
| 62 | +This document is based on AngularJS Git Commit Msg Convention. |
0 commit comments