AngularJS Git Commit Message Conventions
<type>(<scope>) <subject>
another way of reading that is:
what(where) how
in this second form, the when and who are controlled by git itself, so sign your commits.
Some additional clarifications:
-
Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
-
Allowed
-
feat: feature
-
adapt: this is a feature, but it only affects a particular install, not the whole coreBOS project
-
fix: bug fix
-
security
-
i18n: translation strings and enhancements
-
docs: documentation
-
style: formatting, missing semicolons, …
-
refactor: code refactor
-
test: when adding missing tests
-
chore: maintenance tasks
-
-
Allowed could be anything specifying place of the commit change. For example a module name, webservice or functional feature
-
line contains succinct description of the change. Use imperative, present tense: “change” not “changed” nor “changes”.
-
If the commit fixes or is related to a ticket put the title or a summary of it, the actual ticket number is rather useless as time has taught me that ticket systems come and go while code and commit messages persist.
-