Skip to content

Commit a010a8d

Browse files
authored
docs: update version provider install instructions (#1757)
* docs(docs/config/version_provider.md): update version provider docs to use published package install * docs(config/version_provider.md): added editable install instructions for provider * docs(config/version_provider.md): refine provider installation wording * docs(config/version_provider.md): correct indent
1 parent cdaa941 commit a010a8d

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/config/version_provider.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -264,9 +264,18 @@ setup(
264264
### Step 3: Install and Use
265265

266266
1. Install your provider package:
267-
```bash
268-
pip install -e .
269-
```
267+
268+
- Once your custom Commitizen provider is packaged and published (for example, to PyPI), install it like any standard Python package:
269+
270+
```bash
271+
pip install my-commitizen-provider
272+
```
273+
274+
- 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)):
275+
276+
```bash
277+
pip install -e .
278+
```
270279

271280
2. Configure Commitizen to use your provider:
272281
```toml

0 commit comments

Comments
 (0)