https://github.com/natterstefan/example-commitizen-standard-version
This example repository enforces the user to enter a properly formatted commit message via commitizen.
https://github.com/natterstefan/example-commitizen-standard-version
commitizen git-hooks husky standard-versioning
Last synced: about 1 year ago
JSON representation
This example repository enforces the user to enter a properly formatted commit message via commitizen.
- Host: GitHub
- URL: https://github.com/natterstefan/example-commitizen-standard-version
- Owner: natterstefan
- License: mit
- Created: 2019-06-18T17:40:17.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-11T03:09:22.000Z (almost 5 years ago)
- Last Synced: 2025-02-10T11:45:22.995Z (over 1 year ago)
- Topics: commitizen, git-hooks, husky, standard-versioning
- Language: JavaScript
- Homepage: https://github.com/commitizen/cz-cli/issues/631
- Size: 339 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Example - commitizen and standard-version
## Setup
```bash
npm install
npm start # demonstration
```
## How to commit and push changes
This repository _enforces_ the user to enter a properly formatted commit message
via commitizen. You do not have to do anything different than `git commit` when
commiting changes.
Once you have finished the commitizen dialog, you can easily push changes with
`git push`.
## How to release and later publish the package
This package uses [standard-version](https://github.com/conventional-changelog/standard-version)
and [commitizen](https://github.com/commitizen/cz-cli) for standardizing commit
messages, releasing tags and updating the changelog.
When you're ready to release, execute the following commands in the given order:
1. `git checkout master`
2. `git pull origin master`
3. `npm run release` (or `npx standard-version`)
4. `git push --follow-tags origin master`
Now you are ready to publish the package with: `npm publish`
## License
[MIT](LICENSE)