Unverified Commit db346ff9 authored by Samuel Bernard's avatar Samuel Bernard
Browse files

docs: use karma for git format in contributing

parent c9fa515e
......@@ -9,15 +9,20 @@ Your commits must not break any tests, foodcritic nor rubocop.
### Commits format
Your commits must pass `git log --check` and messages should be formated
like this (based on this excellent
[post](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)):
Your commits must pass `git log --check` and messages should be formatted
like this (read
[post](http://karma-runner.github.io/1.0/dev/git-commit-msg.html)
for details):
```
Summarize change in 50 characters or less
type(scope): subject, all in 50 characters or less
Provide more detail after the first line. Leave one blank line below the
summary and wrap all lines at 72 characters or less.
body: Provide more detail after the first line. Leave one blank line
below the summary and wrap all lines at 72 characters or less.
Uses the imperative, present tense: “change” not “changed” nor
"changes". Includes motivation for the change and contrasts with
previous behavior.
If the change fixes an issue, leave another blank line after the final
paragraph and indicate which issue is fixed in the specific format
......@@ -26,6 +31,25 @@ below.
Fix #42
```
Allowed <type> values:
- feat (new feature for the user, not a new feature for build script)
- fix (bug fix for the user, not a fix to a build script)
- docs (changes to the documentation)
- style (formatting, missing semi colons, etc; no production code change)
- refactor (refactoring production code, eg. renaming a variable)
- test (adding missing tests, refactoring tests; no production code change)
- chore (updating grunt tasks etc; no production code change)
Example <scope> values:
- recipe name (like config, install, etc.)
- rubocop, foodcritic, kitchen (when dealing with specific tool)
- etc.
The <scope> can be empty (e.g. if the change is a global or difficult to assign
to a single component), in which case the parentheses are omitted.
Also do your best to factor commits appropriately, ie not too large with
unrelated things in the same commit, and not too small with the same small
change applied N times in N different commits. If there was some accidental
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment