Title: docs(skill): point install guidance at docs README by bearomorphism · Pull Request #1953 · commitizen-tools/commitizen · GitHub
Open Graph Title: docs(skill): point install guidance at docs README by bearomorphism · Pull Request #1953 · commitizen-tools/commitizen
X Title: docs(skill): point install guidance at docs README by bearomorphism · Pull Request #1953 · commitizen-tools/commitizen
Description: Description Follow-up to #1949 addressing review feedback from @philipp-horstenkamp: Shouldn't this be pipx or uv? The merged .agents/skills/commitizen/SKILL.md advertised pip install commitizen as the install command, but docs/README.md recommends pipx install commitizen or uv tool install commitizen for global installs of the cz CLI; pip install -U commitizen is documented only as a project-specific install. Changes Frontmatter install: updated from pip install commitizen to pipx install commitizen to match the docs' primary recommendation. Replaced the inline install command list in Important domain details (which had the same pip/uv add discrepancy) with a short pointer that defers to docs/README.md's Installation section. Added an Installation: entry under Suggested references, matching the file's existing pattern of referencing docs/...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.md makes 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.md That was considered, but it expands scope (mkdocs nav + llmstxt config + risk of breaking external links to the README's #installation anchor) beyond the original review concern. It can be a separate proposal if desired. Checklist I have read the contributing guidelines Was generative AI tooling used to co-author this PR? Yes (GitHub Copilot CLI) Generated-by: GitHub Copilot CLI following the guidelines Code Changes Add test cases to all the changes you introduce (N/A - docs only) Run uv run poe all locally to ensure this change passes linter check and tests (no Python files touched; pre-commit hooks pass on push) Manually test the changes: Verify the feature/bug fix works as expected in real-world scenarios (verified install commands match docs/README.md lines 62-122) Test edge cases and error conditions Ensure backward compatibility is maintained Update the documentation for the changes Documentation Changes Run uv run poe doc locally to ensure the documentation pages renders correctly (only .agents/skills/commitizen/SKILL.md changed, not part of the mkdocs site) Check and fix any broken links (internal or external) - verified docs/README.md reference is valid Steps to Test This Pull Request Open .agents/skills/commitizen/SKILL.md. Confirm the frontmatter install: is pipx install commitizen. Confirm the Important domain details item points to docs/README.md rather than listing install commands inline. Confirm Suggested references contains an Installation entry pointing to docs/README.md. Additional Context Addresses unresolved review feedback from #1949 (already merged).
Open Graph Description: Description Follow-up to #1949 addressing review feedback from @philipp-horstenkamp: Shouldn't this be pipx or uv? The merged .agents/skills/commitizen/SKILL.md advertised pip install commiti...
X Description: Description Follow-up to #1949 addressing review feedback from @philipp-horstenkamp: Shouldn't this be pipx or uv? The merged .agents/skills/commitizen/SKILL.md advertised pip install com...
Opengraph URL: https://github.com/commitizen-tools/commitizen/pull/1953
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:c786dc0c-c857-1d58-9dc7-f76ecd134d53 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | 894C:1971A3:837A63:C128D8:6A4E17F9 |
| html-safe-nonce | da297203c7d13742437df34b366f70ebcb5203d6c326a0a9a327f048e04efd04 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4OTRDOjE5NzFBMzo4MzdBNjM6QzEyOEQ4OjZBNEUxN0Y5IiwidmlzaXRvcl9pZCI6IjMwODE0NDExNTQ2MzUyNzQyMzMiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 66f90c04fc107ecc540fc7c748575cb4b08a3651aecfbc1b6e767dede3a4e3fc |
| hovercard-subject-tag | pull_request:3653909328 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/commitizen-tools/commitizen/pull/1953/files |
| twitter:image | https://avatars.githubusercontent.com/u/26526132?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/26526132?s=400&v=4 |
| og:image:alt | Description Follow-up to #1949 addressing review feedback from @philipp-horstenkamp: Shouldn't this be pipx or uv? The merged .agents/skills/commitizen/SKILL.md advertised pip install commiti... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 030096ee0db095447bfe77409d33bfac127ca7128299c58deef27c52eaa1b1f0 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/commitizen-tools/commitizen git https://github.com/commitizen-tools/commitizen.git |
| octolytics-dimension-user_id | 62252524 |
| octolytics-dimension-user_login | commitizen-tools |
| octolytics-dimension-repository_id | 106127589 |
| octolytics-dimension-repository_nwo | commitizen-tools/commitizen |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 106127589 |
| octolytics-dimension-repository_network_root_nwo | commitizen-tools/commitizen |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | ea9187571e3edc5f2780f750631138669441ca50 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width