This will provide a set of rule to make your commit easier to read
https://www.conventionalcommits.org/en/v1.0.0/
https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13
To summarize:
-
feat
- use when a new feature is added -
fix
- fix a bug -
refactor
- rewrite/restructure code (no behavior changes) -
perf
- improve performance -
style
- style of the file eg. white spaces, formatting, semicolon -
test
- add test or update test -
docs
- format the document not code -
build
- build component eg. project version, dependencies -
ops
- infrastructure -
chore
- other miscellaneous commits eg. update .gitignore
NOTE:
- Use present tense
- Don't capitalize the first letter
- No dot at the end
Example
docs: correct spelling of CHANGELOG
Can also add scope like this
feat(lang): add polish language
Top comments (0)