File tree Expand file tree Collapse file tree 1 file changed +28
-0
lines changed Expand file tree Collapse file tree 1 file changed +28
-0
lines changed Original file line number Diff line number Diff line change
1
+ # commitizen cz template
2
+
3
+ cz template for [ commitizen] ( https://github.com/Woile/commitizen )
4
+
5
+ ## Prerequiste
6
+ * Python 3.x
7
+ * [ cookiecutter] ( https://cookiecutter.readthedocs.io/en/latest/ )
8
+ * ` python -m pip install cookiecutter `
9
+
10
+ ## Usage
11
+
12
+ 1 . Initialize project through cookiecutter
13
+
14
+ ``` sh
15
+ cookiecutter gh:Lee-W/commitizen_cz_template
16
+ ```
17
+
18
+ Note that you don' t need to add cz prefix in your project name and package name.
19
+
20
+ 2. Implement the `questions` and `message` function in your `cz_[cz_name].py`
21
+ 3. Publish it to [pypi](https://pypi.org/) or install locally through `pip install .`
22
+ 4. Test through `cz --name cz_[cz_name] [command]`
23
+
24
+ ## Lisence
25
+ [MIT](https://opensource.org/licenses/MIT)
26
+
27
+ ## Author
28
+ [Lee-W](https://github.com/Lee-W/) ([email protected] )
You can’t perform that action at this time.
0 commit comments