|
1 | | -Commit message format (version 0.1.0) |
| 1 | +Commit message format (version 1.0.0) |
2 | 2 | =================== |
3 | 3 |
|
4 | | - |
5 | | - WHAT IS IT? |
6 | | ------------ |
7 | | - |
8 | | - |
9 | | -HOW TO USE |
10 | | -------------- |
11 | | - |
12 | | - |
13 | | -------------- |
14 | | - |
15 | | - |
16 | | -REFERENCE |
| 4 | +##What is it? |
| 5 | +This is a proposal of tags to be used in commit messages. The goal is to identify easily the different types of changes in the project's repo. |
| 6 | + |
| 7 | +##Commit Message rules |
| 8 | + |
| 9 | +####Subject desription (first line) |
| 10 | +>1. Prefix the line with an applicable emoji (tag) |
| 11 | +>2. Limit the subject line to 50 characters |
| 12 | +>3. Separate subject from body with a blank line |
| 13 | +>4. Capitalize the subject line |
| 14 | +>5. Do not end the subject line with a period |
| 15 | +>6. Use the imperative mood in the subject line |
| 16 | +
|
| 17 | +####Message body |
| 18 | +>7. Wrap the body at 72 characters |
| 19 | +>8. Use the body to explain the problems, limitations, and why is it necessary?. Then to explain how was addressed the issue and the effects. |
| 20 | +
|
| 21 | +A complete description, rules and tips can be seen in [here][1]. |
| 22 | + |
| 23 | +####Tags and meaning |
| 24 | +**NOTE:** The first commit does not have a label, and the message always is "**Initial commit**" as convention. |
| 25 | + |
| 26 | +>* [style] when formatting or comments on code; no code change |
| 27 | +>* [docs] when writing documentation |
| 28 | +>* [code] when improving the format/structure of the code |
| 29 | +>* [bug] when fixing a bug |
| 30 | +>* [new] when adding new feature |
| 31 | +>* [api] when functions, methods or classes have been added or removed; method signatures or return types have changed |
| 32 | +>* [typo] when typos in words or minimal changes in comment sentences |
| 33 | +>* [misc] anything not covered by the above categories, e.g. rename or move files, add configuration files, add dataset |
| 34 | +>* [test] when adding tests, refactoring tests; no production code change |
| 35 | +>* [boost] when improving performance |
| 36 | +>* [pkg] when libraries, frameworks, packages or modules are added |
| 37 | +
|
| 38 | +####Subtags |
| 39 | +>* *linux* when fixing something on Linux |
| 40 | +>* *macos* when fixing something on Mac OS |
| 41 | +>* *win* when fixing something on Windows |
| 42 | +>* *and* when fixing something on Android |
| 43 | +>* *ios* when fixing something on iOS |
| 44 | +>* *winp* when fixing something on Windows Phone |
| 45 | +
|
| 46 | +**NOTE:** The subtags *linux*, *macos*,*and*, *win*, *ios* and *winp* must be used just in combination with other tags to specify a particular change related to an O.S. |
| 47 | +>Example: |
| 48 | +> [api|macos] Subject description |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | +##REFERENCES |
| 53 | + |
| 54 | +1. [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/#why-not-how) Chris Beams |
| 55 | +2. [TYPO3 CMS](http://wiki.typo3.org/CommitMessage_Format_(Git) |
| 56 | +3. [Atom](https://atom.io/docs/v0.186.0/contributing) |
| 57 | +4. [Karma](http://karma-runner.github.io/0.8/dev/git-commit-msg.html) |
| 58 | + |
| 59 | +[1]: http://chris.beams.io/posts/git-commit/#why-not-how |
17 | 60 | ------------- |
18 | | - |
19 | | - |
20 | | -------------- |
21 | | -This document was last modified on : March. 17th, 2015. |
22 | | - |
23 | | - |
| 61 | +This document was last modified on : April. 6th, 2015. |
0 commit comments