diff options
| author | Kali Kaneko (leap communications) <kali@leap.se> | 2016-08-30 11:25:27 -0400 |
|---|---|---|
| committer | Kali Kaneko (leap communications) <kali@leap.se> | 2016-08-30 11:25:35 -0400 |
| commit | a9b4554156bac38cd3ca1162326ce9cf554f9b50 (patch) | |
| tree | 21dacea8338235181b214fa233f93fdff3c0b022 /docs/leap-commit-template.README | |
| parent | 22eec36ff81ae2ec2b924087ed6253894b92278a (diff) | |
[pkg] add some relevant docs
Diffstat (limited to 'docs/leap-commit-template.README')
| -rw-r--r-- | docs/leap-commit-template.README | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/leap-commit-template.README b/docs/leap-commit-template.README new file mode 100644 index 00000000..ce8809e7 --- /dev/null +++ b/docs/leap-commit-template.README @@ -0,0 +1,47 @@ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +HOW TO USE THIS TEMPLATE: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Run `git config commit.template docs/leap-commit-template` or +edit the .git/config for this project and add +`template = docs/leap-commit-template` +under the [commit] block + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +COMMIT TEMPLATE FORMAT EXPLAINED +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +[type] <subject> + +<body> +<footer> + +Type should be one of the following: +- bug (bug fix) +- feat (new feature) +- docs (changes to documentation) +- style (formatting, pep8 violations, etc; no code change) +- refactor (refactoring production code) +- test (adding missing tests, refactoring tests; no production code change) +- pkg (packaging related changes; no production code change) +- i18n translation related changes + +Subject should use imperative tone and say what you did. +For example, use 'change', NOT 'changed' or 'changes'. + +The body should go into detail about changes made. + +The footer should contain any issue references or actions. +You can use one or several of the following: + +- Resolves: #XYZ +- Related: #XYZ +- Documentation: #XYZ +- Releases: XYZ + +The Documentation field should be included in every new feature commit, and it +should link to an issue in the bug tracker where the new feature is analyzed +and documented. + +For a full example of how to write a good commit message, check out +https://github.com/sparkbox/how_to/tree/master/style/git |