From 23f066554e0705aff156496def1804ee4880ee50 Mon Sep 17 00:00:00 2001 From: BelpHegoR17 Date: Sun, 4 Jan 2026 18:19:06 +0530 Subject: [PATCH 1/4] docs(docs/config/version_provider.md): update version provider docs to use published package install --- docs/config/version_provider.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/config/version_provider.md b/docs/config/version_provider.md index 859f84f78..9b6956cd7 100644 --- a/docs/config/version_provider.md +++ b/docs/config/version_provider.md @@ -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 ``` 2. Configure Commitizen to use your provider: From 08b69794326847486136dde3e1a64c5e9aece9ed Mon Sep 17 00:00:00 2001 From: BelpHegoR17 Date: Mon, 5 Jan 2026 20:53:51 +0530 Subject: [PATCH 2/4] docs(config/version_provider.md): added editable install instructions for provider --- docs/config/version_provider.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/config/version_provider.md b/docs/config/version_provider.md index 9b6956cd7..856278014 100644 --- a/docs/config/version_provider.md +++ b/docs/config/version_provider.md @@ -264,11 +264,18 @@ 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 my-commitizen-provider - ``` + - Once your custom Commitizen provider is packaged and published (for example, to PyPI), install it like any standard Python dependency: + + ```bash + pip install my-commitizen-provider + ``` + + - If you want to use 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 From 67582f22a9ab288aaae32cc903d0512f790c68d8 Mon Sep 17 00:00:00 2001 From: BelpHegoR17 Date: Tue, 6 Jan 2026 16:50:50 +0530 Subject: [PATCH 3/4] docs(config/version_provider.md): refine provider installation wording --- docs/config/version_provider.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/config/version_provider.md b/docs/config/version_provider.md index 856278014..1b7151d18 100644 --- a/docs/config/version_provider.md +++ b/docs/config/version_provider.md @@ -265,13 +265,13 @@ setup( 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: + - 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 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)): + - 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 . From 9f3a018b4c515c11da57b3f90e8e7f6a14c31764 Mon Sep 17 00:00:00 2001 From: BelpHegoR17 Date: Tue, 6 Jan 2026 17:24:58 +0530 Subject: [PATCH 4/4] docs(config/version_provider.md): correct indent --- docs/config/version_provider.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/config/version_provider.md b/docs/config/version_provider.md index 1b7151d18..48a49049d 100644 --- a/docs/config/version_provider.md +++ b/docs/config/version_provider.md @@ -267,15 +267,15 @@ setup( - 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 - ``` + ```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 . - ``` + ```bash + pip install -e . + ``` 2. Configure Commitizen to use your provider: ```toml