https://github.com/commitizen-tools/commitizen_cz_template
cz template for commitizen
https://github.com/commitizen-tools/commitizen_cz_template
Last synced: 7 months ago
JSON representation
cz template for commitizen
- Host: GitHub
- URL: https://github.com/commitizen-tools/commitizen_cz_template
- Owner: commitizen-tools
- Created: 2019-12-29T07:11:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-23T06:05:13.000Z (over 2 years ago)
- Last Synced: 2025-03-26T18:21:22.875Z (9 months ago)
- Language: Python
- Size: 7.81 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# commitizen cz template
cz template for [commitizen](https://github.com/commitizen-tools/commitizen) v3+
## Prerequisites
- Python 3.x
- Poetry 1.2.x
- [cookiecutter](https://cookiecutter.readthedocs.io/en/latest/)
- `python -m pip install cookiecutter`
## Usage
1. Initialize project through cookiecutter
```sh
cookiecutter gh:commitizen-tools/commitizen_cz_template
```
Note that you don't need to add cz prefix in your project name and package name.
2. Implement the `questions` and `message` function in your `cz_[cz_name].py`
3. Publish it to [pypi](https://pypi.org/) or install locally through `pip install .`
4. Test through `cz --name cz_[cz_name] [command]`
## License
[MIT](https://opensource.org/licenses/MIT)
## Author
[Lee-W](https://github.com/Lee-W/) ()