Skip to content

Conversation

@BelpHegoR17
Copy link
Contributor

Description

This change updates the version provider documentation to recommend installing a custom Commitizen provider as a published Python package instead of using editable (pip install -e .) installation.

Checklist

Documentation Changes

  • Run uv run poe doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external) in the documentation

Additional Context

Fixes #1707

@codecov
Copy link

codecov bot commented Jan 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.88%. Comparing base (de5c7a9) to head (9f3a018).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1757   +/-   ##
=======================================
  Coverage   97.88%   97.88%           
=======================================
  Files          60       60           
  Lines        2606     2606           
=======================================
  Hits         2551     2551           
  Misses         55       55           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bearomorphism
Copy link
Collaborator

Hi, please rebase to the latest master to resolve pipeline failure, thanks!

@bearomorphism
Copy link
Collaborator

@Lee-W could you review this one? Thanks!

Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mostly good, a few nits.

pip install -e .
```

- Once your custom Commitizen provider is packaged and published (for example, to PyPI), install it like any standard Python dependency:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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:

It's not wrong but I feel it's better this way 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

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)):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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)):

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Comment on lines 270 to 272
```bash
pip install my-commitizen-provider
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the indent level correct? iirc it should be like this:

Suggested change
```bash
pip install my-commitizen-provider
```
```bash
pip install my-commitizen-provider
```

Could you help to check if this renders correctly by running uv run poe doc?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have checked , it is working.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But with your changes, i think its looking better so i think its good to add.

Comment on lines 276 to 278
```bash
pip install -e .
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update the document to instruct the user to build, publish, and install a customized commitizen package instead of installing with edit-mode

4 participants