docs: fix checks best practices examples and add skill links#10591
Merged
docs: fix checks best practices examples and add skill links#10591
Conversation
Remove diff-scoping language ("in the changed code") from examples that
contradicts the page's own advice, delete the Conventional Commits example
since PR title format validation is a pattern-match task better suited
for a linter, and add links to the writing-checks and check skills.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
Docs Review: No additional documentation updates needed. This PR is itself a documentation improvement that:
The changes are well-scoped and improve clarity without expanding scope unnecessarily. |
Contributor
|
No additional documentation updates needed. This PR already contains well-scoped documentation improvements:
All changes align with the documentation's own best practices and improve clarity without adding unnecessary scope. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
writing-checksandcheckskills on their respective pagesTest plan
🤖 Generated with Claude Code
Continue Tasks:▶️ 7 not started · ✅ 13 no changes · 🔴 1 closed — View all
Summary by cubic
Align checks docs with best practices and make skill installation clearer. Removed diff-scoping language from two examples, deleted the Conventional Commits example (title format should be linted), and added links to the writing-checks and check skills.
Written for commit d81d593. Summary will update on new commits.