Skip to content

Commit b565e4b

Browse files
bearomorphismLee-W
authored andcommitted
docs(third-party): resturcture commitizen plugin documentation
1 parent c92280f commit b565e4b

13 files changed

+287
-202
lines changed

docs/customization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ cookiecutter gh:commitizen-tools/commitizen_cz_template
207207

208208
See [commitizen_cz_template](https://github.com/commitizen-tools/commitizen_cz_template) for details.
209209

210-
Once you publish your rules, you can send us a PR to the [Third-party section](./third-party-commitizen.md).
210+
Once you publish your rules, you can send us a PR to the [Third-party section](./third-party-plugins/about.md).
211211

212212
### Custom commit rules
213213

docs/third-party-commitizen.md

Lines changed: 0 additions & 200 deletions
This file was deleted.

docs/third-party-plugins/about.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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 Plugins" to better reflect the content.
12+
13+
## Plugin features
14+
15+
<!-- TODO: provide more details about the features -->
16+
<!-- We can move the details from customization pages to here -->
17+
18+
### Commit message convention
19+
20+
Includes the rules to validate and generate commit messages.
21+
22+
### Version scheme
23+
24+
Includes the rules to generate version numbers.
25+
26+
### Version provider
27+
28+
Read and write version from data sources.
29+
30+
### Changelog format
31+
32+
Generate changelog in customized formats.
33+
34+
<!-- TODO: complete the following section -->
35+
<!-- ## How do I create a new plugin? -->
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. -->
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# [commitizen-deno-provider](https://pypi.org/project/commitizen-deno-provider/)
2+
3+
A provider for **Deno** projects. The provider updates the version in `deno.json` and `jsr.json` files.
4+
5+
<!-- TODO: What features does the plugin provide? -->
6+
7+
## Installation
8+
9+
```sh
10+
pip install commitizen-deno-provider
11+
```
12+
13+
## Usage
14+
15+
Add `deno-provider` to your configuration file.
16+
17+
Example for `.cz.yaml`:
18+
19+
```yaml
20+
---
21+
commitizen:
22+
major_version_zero: true
23+
name: cz_conventional_commits
24+
tag_format: $version
25+
update_changelog_on_bump: true
26+
version_provider: deno-provider
27+
version_scheme: semver
28+
```
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# [Commitizen emoji](https://pypi.org/project/commitizen-emoji/) (Unmaintained)
2+
3+
Just like *conventional commit* format, but with emojis and optionally time spent and related tasks.
4+
5+
<!-- TODO: What features does the plugin provide? -->
6+
7+
## Installation
8+
9+
```sh
10+
pip install commitizen-emoji
11+
```
12+
13+
## Usage
14+
15+
```sh
16+
cz --name cz_commitizen_emoji commit
17+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# [Conventional JIRA](https://pypi.org/project/conventional-JIRA/)
2+
3+
Just like _conventional commit_ format, but the scope has been restricted to a
4+
JIRA issue format, i.e. `project-issueNumber`. This standardises scopes in a
5+
meaningful way.
6+
7+
<!-- TODO: What features does the plugin provide? -->
8+
9+
## Installation
10+
11+
```sh
12+
pip install conventional-JIRA
13+
```

docs/third-party-plugins/cz-ai.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# [cz-ai](https://github.com/watadarkstar/cz_ai)
2+
3+
A Commitizen plugin that leverages OpenAI's GPT-4o to automatically generate clear, concise, and conventional commit messages based on your staged git changes.
4+
5+
<!-- TODO: What features does the plugin provide? -->
6+
7+
## Installation
8+
9+
```sh
10+
pip install cz-ai
11+
```
12+
13+
## Usage
14+
15+
```sh
16+
cz --name cz_ai commit
17+
```
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# [cz-conventional-gitmoji](https://github.com/ljnsn/cz-conventional-gitmoji)
2+
3+
*conventional commit*s, but with [gitmojis](https://gitmoji.dev).
4+
5+
Includes a pre-commit hook that automatically adds the correct gitmoji to the commit message based on the conventional type.
6+
7+
<!-- TODO: What features does the plugin provide? -->
8+
9+
## Installation
10+
11+
```sh
12+
pip install cz-conventional-gitmoji
13+
```
14+
15+
## Usage
16+
17+
```sh
18+
cz --name cz_gitmoji commit
19+
```

0 commit comments

Comments
 (0)