https://github.com/gdfreitasdev/nodejs-commits-patterning-sample
Sample repository for patterning Git commits on Node.js projects
https://github.com/gdfreitasdev/nodejs-commits-patterning-sample
commitlint commitzen conventional-commits husky
Last synced: 8 months ago
JSON representation
Sample repository for patterning Git commits on Node.js projects
- Host: GitHub
- URL: https://github.com/gdfreitasdev/nodejs-commits-patterning-sample
- Owner: gdfreitasdev
- License: mit
- Created: 2021-09-23T23:26:12.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-24T00:27:19.000Z (over 4 years ago)
- Last Synced: 2025-08-07T01:12:21.290Z (9 months ago)
- Topics: commitlint, commitzen, conventional-commits, husky
- Language: Shell
- Homepage:
- Size: 46.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nodejs-commits-patterning-sample
Sample repository for patterning Git commits on Node.js projects
## Usage
It will prompt commitzen for you to compose your commit
```sh
git commit
```
## Hooks
- `prepare-commit-msg` Runs commitzen to compose commit messages
- `pre-commit` Runs static code linting on staged files before git commit
- `commit-msg` Runs commitlint to lint commit message according to conventional commits
- `pre-push` Runs project's test suite before git push
## References
- https://github.com/typicode/husky
- https://github.com/conventional-changelog/commitlint
- https://github.com/commitizen/cz-cli
- https://github.com/okonet/lint-staged