Skip to content

docs: update version provider install instructions #1757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bearomorphism merged 6 commits into from
Jan 15, 2026
Merged

docs: update version provider install instructions #1757

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
23f0665
docs(docs/config/version_provider.md): update version provider docs t…
Stoiicc Jan 4, 2026
f10ec39
Merge branch 'master' into docs/custom-commitizen-package-install
Stoiicc Jan 5, 2026
08b6979
docs(config/version_provider.md): added editable install instructions…
Stoiicc Jan 5, 2026
627ddc3
Merge branch 'master' into docs/custom-commitizen-package-install
Stoiicc Jan 5, 2026
67582f2
docs(config/version_provider.md): refine provider installation wording
Stoiicc Jan 6, 2026
9f3a018
docs(config/version_provider.md): correct indent
Stoiicc Jan 6, 2026
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
4 changes: 3 additions & 1 deletion docs/config/version_provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,8 +264,10 @@ setup(
### Step 3: Install and Use

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

```bash
pip install -e .
pip install my-commitizen-provider
Comment thread
noirbizarre marked this conversation as resolved.
Outdated
```

2. Configure Commitizen to use your provider:
Expand Down