Contribute

Fork this repository
Create a branch with your feature: git checkout -b my-feature
Commit your changes: git commit -m 'feat: add my new feature'
Push it to your branch: git push origin my-feature

After merging your pull request, your branch can be deleted.

Commit Message

The type and verb should always be lowercase
Don't end the subject line with a period
Use verbs with the imperative, present tense: “change” not “changed” nor “changes”
Example:
- feat: add new user feature
- fix: fix user image path

Types

feat: new feature for the user, not a new feature for build script
fix: bug fix for the user, not a fix to a build script
refactor: refactoring production code, eg. renaming a variable
chore: updating tasks, build tool, bundler, etc; no production code change
test: adding missing tests, refactoring tests; no production code change
style: formatting, missing semi colons, etc; no production code change
docs: changes to the documentation

Verbs

add: create a capability e.g. feature, test, dependency
update: update a capability e.g. feature, test, dependency
fix: fix an issue e.g. bug, typo, accident, misstatement
remove: remove a capability e.g. feature, test, dependency
refactor: a code change that must be just a refactoring
reformat: refactor of formatting, e.g. omit whitespace
document: refactor of documentation, e.g. help files
bump: increase the version of something e.g. dependency
make: change the build process, or tooling, or infra
optimise: refactor of performance, e.g. speed up code
start: begin doing something; e.g. create a feature flag
stop: end doing something; e.g. remove a feature flag

Reference

This document is based on Karma's Git Commit Msg Convention