Skip to content

Commit 08b6979

Browse files
committed
docs(config/version_provider.md): added editable install instructions for provider
1 parent f10ec39 commit 08b6979

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

docs/config/version_provider.md

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

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

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

273280
2. Configure Commitizen to use your provider:
274281
```toml

0 commit comments

Comments
 (0)