|
| 1 | +# Git Comment Convention |
| 2 | + |
| 3 | + |
| 4 | +## Comment structure |
| 5 | +1. First line is a subject line. It should have size about 50 characters, maximum limit is 80. Subject line is capitalized and hasn't period at the end; |
| 6 | +2. A blank line separates subject from body; |
| 7 | +3. Detailed description of the change in the body, breaking paragraphs where needed.The body should explain what you did and why vs. how. The body also starts with a capitalized letter. Bullet points are made with an asterisk (*); |
| 8 | +4. In case if a bug tracking system is used, bug Id is line is placed at the very end after a blank line. |
| 9 | + |
| 10 | + |
| 11 | +## Subject line tags |
| 12 | +- [FEATURE]: A new feature (also small additions). Most likely it will be an added feature, but it could also be removed; |
| 13 | +- [BUGFIX]: A fix for a bug; |
| 14 | +- [STYLE]: Changes in layout, page style and css files; |
| 15 | +- [CLEANUP]: Code formatting, improves in code style and readability; |
| 16 | +- [DOCS]: Changes to documentation; |
| 17 | +- [TEST]: Adding, changing, refactoring tests - no production code change; |
| 18 | +- [OTHER]: Anything not covered by the above categories. |
| 19 | + |
| 20 | + |
| 21 | +## Flags have to be added under certain circumstances |
| 22 | +- (!!!) : Breaking change. Significant changes in software architecture or logic, that affect existing features and extentions or change user experience; |
| 23 | +- (DB): Changes that require database structure or data to be updated; |
| 24 | +- (WIP): Work in progress. This flag will be removed, once the final version of a change is available. Changes marked WIP are never merged. |
| 25 | + |
| 26 | + |
| 27 | +## Tags usage examples |
| 28 | +1. [STYLE] Измение размера тэга h1 |
| 29 | +2. [CLEANUP] Небольшое форматирование кода |
| 30 | +3. [BUGFIX] При изменении модели ApplicationUser, не происходит автоматическое удаление базы и создание ее с новой структурой |
| 31 | +4. [FEATURE] Добавлен универсальный объект для создания графиков |
| 32 | +5. (!!!)[FEATURE] Исправлен класс ChartItem |
| 33 | +6. (!!!)(DB)[FEATURE] Добавлен целочисленный ApplicationUserID |
| 34 | + |
| 35 | +## Commit Message Example |
| 36 | +(!!!)(DB)[FEATURE]Возврат к строковым идентификаторам в таблицах для авторизации пользователей |
| 37 | + |
| 38 | +Поскольку не все встроенные в Microsoft Identity Owin 2.0 методы поддерживают |
| 39 | +использование целочисленных значений в ID, тип данных для этого поля был сменен на string. |
| 40 | + |
| 41 | + |
| 42 | +## Source |
| 43 | +- [WIKI OpenStack Information in commit messages](https://wiki.openstack.org/wiki/GitCommitMessages#Information_in_commit_messages) |
| 44 | +- [Karma-Runner Git Commit Msg](http://karma-runner.github.io/0.8/dev/git-commit-msg.html) |
| 45 | +- [Wiki.Typo3.Org CommitMessage Format](http://wiki.typo3.org/CommitMessage_Format_(Git)) |
| 46 | +- [How to Write a Git Commit Message ](http://www.chrisbeams.com/posts/git-commit/) |
0 commit comments