From 5fcda2cbf2f5687910ca9579e4ba823d98603c8d Mon Sep 17 00:00:00 2001 From: Tim Hsiung Date: Sat, 9 May 2026 13:49:15 +0800 Subject: [PATCH] docs(skill): use pipx for recommended global install The SKILL.md install hint advertised `pip install commitizen`, but the project README recommends a global, isolated install via pipx or uv for the `cz` CLI; plain pip is documented only for project-specific installs. Switch to `pipx install commitizen` to match the primary recommendation in docs/README.md. Addresses review feedback on #1949. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .agents/skills/commitizen/SKILL.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.agents/skills/commitizen/SKILL.md b/.agents/skills/commitizen/SKILL.md index 0aa3871b8..dc957abca 100644 --- a/.agents/skills/commitizen/SKILL.md +++ b/.agents/skills/commitizen/SKILL.md @@ -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 @@ -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. @@ -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