docs(skill): point install guidance at docs README#1953
Open
bearomorphism wants to merge 1 commit intocommitizen-tools:masterfrom
Open
docs(skill): point install guidance at docs README#1953bearomorphism wants to merge 1 commit intocommitizen-tools:masterfrom
bearomorphism wants to merge 1 commit intocommitizen-tools:masterfrom
Conversation
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 commitizen-tools#1949. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Follow-up to #1949 addressing review feedback from @philipp-horstenkamp:
The merged
.agents/skills/commitizen/SKILL.mdadvertisedpip install commitizenas the install command, butdocs/README.mdrecommendspipx install commitizenoruv tool install commitizenfor global installs of theczCLI;pip install -U commitizenis documented only as a project-specific install.Changes
install:updated frompip install commitizentopipx install commitizento match the docs' primary recommendation.pip/uv adddiscrepancy) with a short pointer that defers todocs/README.md's Installation section.Installation:entry under Suggested references, matching the file's existing pattern of referencingdocs/...md.Why a pointer instead of duplicating the matrix
Keeping the full install command list in two places was the root cause of the original review comment: the SKILL.md had drifted from the docs. Pointing at
docs/README.mdmakes the docs the single source of truth. The frontmatter still carries one canonical command because the Agent Skills spec expects a literal command there.Why not extract a separate
docs/installation.mdThat was considered, but it expands scope (mkdocs nav +
llmstxtconfig + risk of breaking external links to the README's#installationanchor) beyond the original review concern. It can be a separate proposal if desired.Checklist
Was generative AI tooling used to co-author this PR?
Generated-by: GitHub Copilot CLI following the guidelines
Code Changes
uv run poe alllocally to ensure this change passes linter check and tests (no Python files touched; pre-commit hooks pass on push)docs/README.mdlines 62-122)Documentation Changes
uv run poe doclocally to ensure the documentation pages renders correctly (only.agents/skills/commitizen/SKILL.mdchanged, not part of the mkdocs site)docs/README.mdreference is validSteps to Test This Pull Request
.agents/skills/commitizen/SKILL.md.install:ispipx install commitizen.docs/README.mdrather than listing install commands inline.Installationentry pointing todocs/README.md.Additional Context
Addresses unresolved review feedback from #1949 (already merged).