# install dependencies
$ yarn
# start dev server
$ yarn start
# build docs
$ yarn build
# deploy the document to the GitHub page
$ yarn deploy
Common types according to commitlint-config-conventional (based on the Angular convention) can be:
- build
- chore
- ci
- docs
- feat
- fix
- perf
- refactor
- revert
- style
- test
Real world examples can look like this:
- chore: run tests on travis ci
- fix(server): send cors headers
- feat(blog): add comment section
More: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
MIT