diff --git a/README.md b/README.md index 7ffbcec05..175cf2615 100644 --- a/README.md +++ b/README.md @@ -34,3 +34,10 @@ Builder of Bits aka The [MDN Web Docs interactive examples](https://github.com/m |----> js # All JS examples |----> tabbed # All examples using the tabbed UI ``` + +## Using Commitizen CLI + +This project uses Commitizen to ensure all pull requests follow the same format, and to ensure predictable releases with semantic-release. + +To use this flow, add files as you normally would with `git add .`, and when you are ready to commit, simply type `git commit` and follow the prompts. +You can [read more on the Conventional Changelog format](https://github.com/conventional-changelog/conventional-changelog) on its repository. diff --git a/package.json b/package.json index b370bc077..1628940a2 100644 --- a/package.json +++ b/package.json @@ -113,5 +113,10 @@ "commitizen": { "path": "./node_modules/cz-conventional-changelog" } + }, + "husky": { + "hooks": { + "prepare-commit-msg": "exec < /dev/tty && git cz --hook || true" + } } }