Skip to content
Open
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
15 changes: 12 additions & 3 deletions docs/config/version_provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,9 +264,18 @@ setup(
### Step 3: Install and Use

1. Install your provider package:
```bash
pip install -e .
```

- Once your custom Commitizen provider is packaged and published (for example, to PyPI), install it like any standard Python package:

```bash
pip install my-commitizen-provider
```

- If you want to use the provider directly from the current project source (during development), install it in editable mode ([See pip documentation](https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-e)):

```bash
pip install -e .
```

2. Configure Commitizen to use your provider:
```toml
Expand Down