Rules §
- Separate subject from body with a blank line
- Do not end subject with a period
- Capitalise first word of subject
- User imperative mood,
Subject.length <= 50
Body.wrapLength = 72
Guides §
- If your PMS supports tickets/ issues,
- Subject:
[#<issues number>] Update npm dependency to latest version
- Body:
Refer to issue #<issues number>
- Ensure that the commit message properly fit in the phrase,
If applied, this commit will <your subject line here>
- Have commit types in the start of the subject,
chore: Update npm dependency to latest version
Commit types (note to self) §
feat
- new feature
chore
- changes that don’t modify src/test files
fix
- bug fixes
refactor
- refactoring
docs
- updates on documentation
test
- for test cases
revert
- when reverting to older commit
hot-fix
- emergency fix
Refs §
- https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/
- https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53