-
Notifications
You must be signed in to change notification settings - Fork 34
Git commits guides
Artem edited this page Jul 10, 2014
·
2 revisions
Here is guideline for project commits
- Please, write understandable, not huge commit messages
- Commit message should have tag or tags (not Git's tag), it's just my name of this part of commit message
- Please use GitHub's feature to close or reference by commit message!
Examples:
- git commit -m '[feature] added support for AnotherGreatMusicPlayer, fixed #124591'
- git commit -m '[fix][docs] fixed crash in WAIL intents processing, changed README about this part of the app, fixed #5192'
"[feature][fix][docs]" — tags. Tags help developers to understand main purpose of commit without reading it or reviewing.
Here is list of common tags:
- [project] — when commit updates project's level things, like build.gradle or folders structure
- [docs] — when commit updates README.md or javadoc or comments
- [fix] — when commit contains bug fix, please use GitHub's feature to close or reference by commit message!
- [feature][task] — when commit contains feature implementation, please use GitHub's feature to close or reference by commit message!
- [anything_you_want_to_use_as_tag] — your custom tags, if you want :)