|
| 1 | +# GIT COMMIT MESSAGE CHEAT SHEET |
| 2 | + |
| 3 | +**Proposed format of the commit message** |
| 4 | + |
| 5 | +``` |
| 6 | +<type>(<scope>): <subject> |
| 7 | +
|
| 8 | +<body> |
| 9 | +``` |
| 10 | + |
| 11 | +All lines are wrapped at 100 characters ! |
| 12 | + |
| 13 | +**Allowed `<type>`** |
| 14 | + |
| 15 | +- feat (A new feature) |
| 16 | +- fix (A bug fix) |
| 17 | +- docs (Documentation only changes) |
| 18 | +- style (Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)) |
| 19 | +- perf (A code change that improves performance) |
| 20 | +- refactor (A code change that neither fixes a bug nor adds a feature) |
| 21 | +- build (Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)) |
| 22 | +- ci (Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)) |
| 23 | +- chore (Other changes that don't modify src or test files) |
| 24 | +- revert (Reverts a previous commit) |
| 25 | + |
| 26 | +**Allowed `<scope>`** |
| 27 | +Scope could be anything specifying place of the commit change. |
| 28 | + |
| 29 | +For example $location, $browser, compiler, scope, ng:href, etc... |
| 30 | + |
| 31 | + |
| 32 | +**Breaking changes** |
| 33 | +All breaking changes have to be mentioned in message body, on separated line: |
| 34 | + _Breaks removed $browser.setUrl() method (use $browser.url(newUrl))_ |
| 35 | + _Breaks ng: repeat option is no longer supported on selects (use ng:options)_ |
| 36 | + |
| 37 | + |
| 38 | +**Message body** |
| 39 | + |
| 40 | +- uses the imperative, present tense: “change” not “changed” nor “changes” |
| 41 | +- includes motivation for the change and contrasts with previous behavior |
0 commit comments