Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ cookiecutter gh:commitizen-tools/commitizen_cz_template

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

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

### Custom commit rules

Expand Down
200 changes: 0 additions & 200 deletions docs/third-party-commitizen.md

This file was deleted.

74 changes: 74 additions & 0 deletions docs/third-party-plugins/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# 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.

## How do I create a new plugin?

<!-- TODO -->

## 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. -->
28 changes: 28 additions & 0 deletions docs/third-party-plugins/commitizen-deno-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# [commitizen-deno-provider](https://pypi.org/project/commitizen-deno-provider/)

A provider for **Deno** projects. The provider updates the version in `deno.json` and `jsr.json` files.

<!-- TODO: What features does the plugin provide? -->

## Installation

```sh
pip install commitizen-deno-provider
```

## Usage

Add `deno-provider` to your configuration file.

Example for `.cz.yaml`:

```yaml
---
commitizen:
major_version_zero: true
name: cz_conventional_commits
tag_format: $version
update_changelog_on_bump: true
version_provider: deno-provider
version_scheme: semver
```
17 changes: 17 additions & 0 deletions docs/third-party-plugins/commitizen-emoji.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [Commitizen emoji](https://pypi.org/project/commitizen-emoji/) (Unmaintained)

Just like *conventional commit* format, but with emojis and optionally time spent and related tasks.

<!-- TODO: What features does the plugin provide? -->

## Installation

```sh
pip install commitizen-emoji
```

## Usage

```sh
cz --name cz_commitizen_emoji commit
```
13 changes: 13 additions & 0 deletions docs/third-party-plugins/conventional-jira.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# [Conventional JIRA](https://pypi.org/project/conventional-JIRA/)

Just like _conventional commit_ format, but the scope has been restricted to a
JIRA issue format, i.e. `project-issueNumber`. This standardises scopes in a
meaningful way.

<!-- TODO: What features does the plugin provide? -->

## Installation

```sh
pip install conventional-JIRA
```
17 changes: 17 additions & 0 deletions docs/third-party-plugins/cz-ai.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [cz-ai](https://github.com/watadarkstar/cz_ai)

A Commitizen plugin that leverages OpenAI's GPT-4o to automatically generate clear, concise, and conventional commit messages based on your staged git changes.

<!-- TODO: What features does the plugin provide? -->

## Installation

```sh
pip install cz-ai
```

## Usage

```sh
cz --name cz_ai commit
```
19 changes: 19 additions & 0 deletions docs/third-party-plugins/cz-conventional-gitmoji.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# [cz-conventional-gitmoji](https://github.com/ljnsn/cz-conventional-gitmoji)

*conventional commit*s, but with [gitmojis](https://gitmoji.dev).

Includes a pre-commit hook that automatically adds the correct gitmoji to the commit message based on the conventional type.

<!-- TODO: What features does the plugin provide? -->

## Installation

```sh
pip install cz-conventional-gitmoji
```

## Usage

```sh
cz --name cz_gitmoji commit
```
Loading