Skip to content

Commit

Permalink
docs(third-party-commitizen): uniformize the third party page
Browse files Browse the repository at this point in the history
- Create a top level heading for provider to mirror the template heading
- Uniformize the installation/usage sub-heading for each template/provider
- Uniformize the code-block syntax highlighting
  • Loading branch information
dhmmasson authored and Lee-W committed Oct 16, 2024
1 parent e821569 commit 1d5f295
Showing 1 changed file with 31 additions and 14 deletions.
45 changes: 31 additions & 14 deletions docs/third-party-commitizen.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ 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.

### Installation
#### Installation

```sh
pip install conventional-JIRA
Expand All @@ -23,25 +23,25 @@ This plugin extends the commitizen tools by:
- creating links to GitHub commits in the CHANGELOG.md
- creating links to JIRA issues in the CHANGELOG.md

### Installation
#### Installation

```sh
pip install cz-github-jira-conventional
```

For installation instructions (configuration and pre-commit) please visit https://github.com/apheris/cz-github-jira-conventional
For installation instructions (configuration and pre-commit) please visit [https://github.com/apheris/cz-github-jira-conventional](https://github.com/apheris/cz-github-jira-conventional)

### [cz-emoji](https://github.com/adam-grant-hendry/cz-emoji)

_conventional commit_ format, but with emojis

### Installation
#### Installation

```sh
pip install cz-emoji
```

### Usage
#### Usage

```sh
cz --name cz_emoji commit
Expand All @@ -53,45 +53,62 @@ cz --name cz_emoji commit

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

### Installation
#### Installation

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

### Usage
#### Usage

```bash
```sh
cz --name cz_gitmoji commit
```

### [Commitizen emoji](https://pypi.org/project/commitizen-emoji/) (Unmaintained)

Just like _conventional commit_ format, but with emojis and optionally time spent and related tasks.

It can be installed with `pip install commitizen-emoji`.
#### Installation

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

Usage: `cz --name cz_commitizen_emoji commit`.
#### Usage

```sh
cz --name cz_commitizen_emoji commit
```

### [Conventional Legacy (cz_legacy)][1]

An extension of the _conventional commit_ format to include user-specified
legacy change types in the `CHANGELOG` while preventing the legacy change types
from being used in new commit messages

`cz_legacy` can be installed with `pip install cz_legacy`
#### Installation

```sh
pip install cz_legacy
```

#### Usage

See the [README][1] for instructions on configuration

[1]: https://pypi.org/project/cz_legacy

## Third-Party Commitizen Providers

Commitizen can read and write version from different sources. In addition to the native providers, some alternative version sources are available as PyPI packages (installable with `pip`).

### [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.
A provider for **Deno** projects. The provider updates the version in deno.json and jsr.json files.

#### Installation


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

0 comments on commit 1d5f295

Please sign in to comment.