22Commitizen
33=============
44
5- Python 3 command line utility to standardize commit messages
5+ Python 3 command line utility to standardize commit messages and bump version
66
77
88.. image :: https://img.shields.io/travis/Woile/commitizen.svg?style=flat-square
@@ -35,30 +35,46 @@ Commitizen
3535About
3636==========
3737
38- This is an interactive tool to commit based on some rules (like conventional commits).
38+ Interactive tool to commit based on established rules (like conventional commits).
3939
40- It comes with some defaults commit styles, like conventional commits and jira and it's easily extendable.
40+ It comes with some defaults commit styles,
41+ like conventional commits and jira and it's easily extendable.
4142
4243It's useful for teams, because it is possible to standardize the commiting style.
4344
45+ Also includes an automatic version bump system based on semver.
46+ 4447
4548Installation
4649=============
4750
4851::
4952
50- pip install commitizen
53+ pip install -U commitizen
54+ 55+ ::
56+ 57+ poetry add commitizen --dev
5158
5259
53- For beta
60+ ** Global installation **
5461
5562::
5663
5764 sudo pip3 install -U commitizen
5865
66+ Features
67+ ========
5968
60- Information
61- ===========
69+ - Prompt your commit rules to the user
70+ - Display information about your commit rules (schema, example, info)
71+ - Auto **bump ** version based on semver using your rules (currently there is only support for conventionalcommits)
72+ - Future: New documentation
73+ - Future: Autochangelog
74+ 75+ 76+ Commit rules
77+ ============
6278
6379This client tool prompts the user with information about the commit.
6480
@@ -117,8 +133,9 @@ Usage
117133
118134::
119135
136+ $ cz --help
120137 usage: cz [-h] [--debug] [-n NAME] [--version]
121- {ls,commit,c,example,info,schema} ...
138+ {ls,commit,c,example,info,schema,bump } ...
122139
123140 Commitizen is a cli tool to generate conventional commits.
124141 For more information about the topic go to https://conventionalcommits.org/
@@ -130,26 +147,49 @@ Usage
130147 --version get the version of the installed commitizen
131148
132149 commands:
133- {ls,commit,c,example,info,schema}
150+ {ls,commit,c,example,info,schema,bump }
134151 ls show available commitizens
135152 commit (c) create new commit
136153 example show commit example
137154 info show information about the cz
138155 schema show commit schema
156+ bump bump semantic version based on the git log
139157
140158
141159Configuration
142160==============
143161
144- You can create in your project folder a file called :code: `.cz `, :code: `.cz.cfg ` or in your :code: `setup.cfg `
145- or if you want to configure the global default in your user's home folder a :code: `.cz ` file
146- with the following information:
162+ **New! **: Support for ``pyproject.toml ``
163+ 164+ In your ``pyproject.toml `` you can add an entry like this:
165+ 166+ ::
167+ 168+ [tool.commitizen]
169+ name = cz_conventional_commits
170+ version = "0.1.0"
171+ files = [
172+ "src/__version__.py",
173+ "pyproject.toml"
174+ ]
175+ 176+ 177+ Also, you can create in your project folder a file called
178+ :code: `.cz `, :code: `.cz.cfg ` or in your :code: `setup.cfg `
179+ or if you want to configure the global default in your user's home
180+ folder a :code: `.cz ` file with the following information:
147181
148182::
149183
150184 [commitizen]
151185 name = cz_conventional_commits
186+ version = 0.1.0
187+ files = [
188+ "src/__version__.py",
189+ "pyproject.toml"
190+ ]
152191
192+ The extra tab at the end (``] ``) is required.
153193
154194Creating a commiter
155195========================
0 commit comments