Title: docs(skill): remove broken doc references and unused compatibility field by bearomorphism · Pull Request #1956 · commitizen-tools/commitizen · GitHub
Open Graph Title: docs(skill): remove broken doc references and unused compatibility field by bearomorphism · Pull Request #1956 · commitizen-tools/commitizen
X Title: docs(skill): remove broken doc references and unused compatibility field by bearomorphism · Pull Request #1956 · commitizen-tools/commitizen
Description: Description Cleans up .agents/skills/commitizen/SKILL.md based on feedback in #1936 (comment) and the Agent Skills specification. Remove the Suggested references section. The section listed paths like docs/commands/commit.md that are relative to the repo root, not the skill root. Per the spec, file references in a SKILL.md should be relative to the skill root, and skill folders are typically distributed standalone, so those references could not resolve. The canonical docs URL remains discoverable via metadata.docs in the frontmatter. Drop the compatibility frontmatter field. The spec notes that "most skills do not need" this field, and the previous value (Git repository with Python and Commitizen available...) did not describe a constraint that would actually prevent the skill from running. Checklist I have read the contributing guidelines Was generative AI tooling used to co-author this PR? Yes (please specify the tool below) Generated-by: GitHub Copilot CLI (Claude Opus 4.7) following the guidelines Code Changes Add test cases to all the changes you introduce Run uv run poe all locally to ensure this change passes linter check and tests Manually test the changes: Verify the feature/bug fix works as expected in real-world scenarios Test edge cases and error conditions Ensure backward compatibility is maintained Document any manual testing steps performed Update the documentation for the changes N/A: no code changes; only updates to .agents/skills/commitizen/SKILL.md. No new test cases needed. SKILL.md frontmatter still validates as YAML and the body still parses as Markdown. Documentation Changes Run uv run poe doc locally to ensure the documentation pages renders correctly Check and fix any broken links (internal or external) SKILL.md is not part of the MkDocs site; it is consumed by Agent Skills clients. The change removes broken links rather than introducing new ones, and the metadata.docs URL was verified to point at the live docs site. Expected Behavior Agent Skills clients that load .agents/skills/commitizen/SKILL.md no longer see references to docs/... paths that do not exist when the skill folder is installed standalone. The frontmatter remains spec-valid (no required fields removed), so existing clients continue to discover and activate the skill. Agents looking for canonical documentation can still find it via metadata.docs (https://commitizen-tools.github.io/commitizen/). Steps to Test This Pull Request Check out this branch and open .agents/skills/commitizen/SKILL.md. Confirm the YAML frontmatter parses (e.g. python -c "import yaml,pathlib,re; t=pathlib.Path('.agents/skills/commitizen/SKILL.md').read_text(); fm=re.match(r'---\n(.*?)\n---', t, re.S).group(1); yaml.safe_load(fm)"). Confirm there is no compatibility: key and no ## Suggested references section. Validate against the spec rules in https://agentskills.io/specification.md (required name and description are present and within length limits). Additional Context Follow-up to comment in #1936: #1936 (comment) Agent Skills spec (file references must be relative to the skill root, compatibility is optional and most skills do not need it): https://agentskills.io/specification.md
Open Graph Description: Description Cleans up .agents/skills/commitizen/SKILL.md based on feedback in #1936 (comment) and the Agent Skills specification. Remove the Suggested references section. The section listed paths ...
X Description: Description Cleans up .agents/skills/commitizen/SKILL.md based on feedback in #1936 (comment) and the Agent Skills specification. Remove the Suggested references section. The section listed paths ...
Opengraph URL: https://github.com/commitizen-tools/commitizen/pull/1956
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:561f7f91-c9ed-8fe1-ebe6-9c7d6b042dcd |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | D252:10263B:55422E:72E3BC:6A4DCD7A |
| html-safe-nonce | d2fff44bd7cca359829fa9d30b3e5b9b937b856b89a9002d55d6f5f417820a07 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEMjUyOjEwMjYzQjo1NTQyMkU6NzJFM0JDOjZBNERDRDdBIiwidmlzaXRvcl9pZCI6IjM2NTUxOTM0MDE3Nzc1NzMyNDIiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 2ea50b776307cfc849bea44052840711b58f4c6ca110303d97c0c15d92e5a2f8 |
| hovercard-subject-tag | pull_request:3654029435 |
| 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/1956/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 Cleans up .agents/skills/commitizen/SKILL.md based on feedback in #1936 (comment) and the Agent Skills specification. Remove the Suggested references section. The section listed paths ... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 06b8a6144231bf3a234f1c2e9993861e07ce98a905912b114aa386c2d7e84b33 |
| 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 | 1d344bdb7547fe6bca17a59bb2b8aac3dc9532a0 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width