diff --git a/docs/config/version_provider.md b/docs/config/version_provider.md index 859f84f78..48a49049d 100644 --- a/docs/config/version_provider.md +++ b/docs/config/version_provider.md @@ -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