1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
# What are third-party plugins?
Third-party plugins are a way to extend Commitizen with additional customized features.
These plugins are available as PyPI packages (installable with `pip`).
!!! note
New plugins are welcome! Once you published your plugins, please send us a PR to update this page.
!!! note "Historical notes"
This section was originally called "Third-Party Commitizen Templates", but has been renamed to "Third-Party Commitizen Plugins" to better reflect the content.
## Plugin features
<!-- TODO: provide more details about the features -->
<!-- We can move the details from customization pages to here -->
### Commit message convention
Includes the rules to validate and generate commit messages.
### Version scheme
Includes the rules to generate version numbers.
### Version provider
Read and write version from data sources.
### Changelog format
Generate changelog in customized formats.
<!-- TODO: complete the following section -->
<!-- ## How do I create a new plugin? -->
## How to help us update the list of plugins?
Please document what features the plugin provides:
- a convention
- a scheme
- a provider
- a `changelog_format`
Of course, a plugin can provide multiple features.
You may have noticed that `commitizen` itself can be viewed as a plugin that provides all the above features.
Please see [cz-path](./cz-path.md) for a detailed example.
## New plugin documentation template
# [Package name](https://github.com/author/package-name)
<!-- Description of the plugin. -->
<!-- What features does the plugin provide? -->
## Installation
```sh
pip install package-name
```
## Usage
```sh
cz --name package-name commit
```
## Example
<!-- Example usage of the plugin. -->
|
