File tree Expand file tree Collapse file tree 1 file changed +11
-6
lines changed Expand file tree Collapse file tree 1 file changed +11
-6
lines changed Original file line number Diff line number Diff line change 1
-
2
1
[ ![ Github Actions] ( https://github.com/Woile/commitizen/workflows/Python%20package/badge.svg?style=flat-square )] ( https://github.com/Woile/commitizen/actions )
3
2
[ ![ Conventional
4
3
Commits] ( https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square )] ( https://conventionalcommits.org )
@@ -8,7 +7,6 @@ release](https://img.shields.io/pypi/v/commitizen.svg?style=flat-square)](https:
8
7
versions] ( https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square )] ( https://pypi.org/project/commitizen/ )
9
8
[ ![ Codecov] ( https://img.shields.io/codecov/c/github/Woile/commitizen.svg?style=flat-square )] ( https://codecov.io/gh/Woile/commitizen )
10
9
11
-
12
10
![ Using commitizen cli] ( images/demo.gif )
13
11
14
12
## About
@@ -49,6 +47,7 @@ sudo pip3 install -U Commitizen
49
47
### Python project
50
48
51
49
You can add it to your local project using one of these:
50
+
52
51
``` bash
53
52
pip install -U commitizen
54
53
```
@@ -61,14 +60,17 @@ poetry add commitizen --dev
61
60
62
61
### Commiting
63
62
64
-
65
63
Run in your terminal
66
64
67
- cz commit
65
+ ``` bash
66
+ cz commit
67
+ ```
68
68
69
69
or the shortcut
70
70
71
- cz c
71
+ ``` bash
72
+ cz c
73
+ ```
72
74
73
75
### Help
74
76
@@ -94,7 +96,10 @@ commands:
94
96
info show information about the cz
95
97
schema show commit schema
96
98
bump bump semantic version based on the git log
97
- check validates that a commit message matches the commitizen schema
99
+ version get the version of the installed commitizen or the
100
+ current project (default: installed commitizen)
101
+ check validates that a commit message matches the commitizen
102
+ schema
98
103
```
99
104
100
105
## Contributing
You can’t perform that action at this time.
0 commit comments