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