Heads Up! You're viewing the docs for v0.6, an old version of Karma.
v6.4 is the newest.
Git Commit Msg
Format of the commit message:
<type>(<scope>): <subject>
<body>
<footer>
Message subject (first line) #
First line cannot be longer than 70 characters, second line is always blank and other lines should be wrapped at 80 characters.
Allowed <type> values: #
- feat (new feature)
- fix (bug fix)
- docs (changes to documentation)
- style (formatting, missing semi colons, etc; no code change)
- refactor (refactoring production code)
- test (adding missing tests, refactoring tests; no production code change)
- chore (updating grunt tasks etc; no production code change)
Example <scope> values: #
- init
- runner
- watcher
- config
- web-server
- proxy
- adapter.jasmine
- launcher.chrome
- etc.
The <scope> can be empty (eg. if the change is a global or difficult
to assign to a single component), in which case the parentheses are
omitted.
Message body #
- uses the imperative, present tense: “change” not “changed” nor “changes”
- includes motivation for the change and contrasts with previous behavior
For more info about message body, see:
- http://365git.tumblr.com/post/3308646748/writing-git-commit-messages
- http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
Message footer #
Referencing issues #
Closed issues should be listed on a separate line in the footer prefixed with "Closes" keyword like this:
Closes #234
or in case of multiple issues:
Closes #123, #245, #992
Breaking changes #
All breaking changes have to be mentioned in footer with the description of the change, justification and migration notes.
BREAKING CHANGE:
`port-runner` command line option has changed to `runner-port`, so that it is
consistent with the configuration file syntax.
To migrate your project, change all the commands, where you use `--port-runner`
to `--runner-port`.
This document is based on AngularJS Git Commit Msg Convention.