Skip to content

docs(skill): point install guidance at docs README #1953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bearomorphism wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(skill): point install guidance at docs README #1953

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .agents/skills/commitizen/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ compatibility: Git repository with Python and Commitizen available as `cz` or ru
metadata:
project: commitizen-tools/commitizen
docs: https://commitizen-tools.github.io/commitizen/
install: "pip install commitizen"
install: "pipx install commitizen"
---

# Commitizen
Expand Down Expand Up @@ -39,7 +39,7 @@ Commitizen is a CLI for enforcing Conventional Commits, automating version bumps

## Important domain details

- Commitizen installs with `pip install commitizen` or `uv add commitizen`.
- Commitizen supports both global installation (recommended for the `cz` CLI) and project-local installation; see the installation section in `docs/README.md` for the full matrix of supported tools.
- The default version scheme is PEP 440; `semver` and `semver2` are also supported.
- Common version providers include `commitizen`, `pep621`, `poetry`, `cargo`, `npm`, `composer`, `uv`, and `scm`.
- `cz changelog` generates Markdown changelogs.
Expand All @@ -63,6 +63,8 @@ Commitizen is a CLI for enforcing Conventional Commits, automating version bumps
- `docs/tutorials/gitlab_ci.md`
- Error handling:
- `docs/exit_codes.md`
- Installation:
- `docs/README.md` (see the *Installation* section for global vs project-local options)

## Examples

Expand Down
Loading