docs(skill): consolidate the writing rules and ship a checker for them - #59
Merged
Merged
Conversation
Occam's razor was stated in five places, so the skill broke the rule it teaches; it now has one heading. Examples lead with the good form, a negation takes `does not` rather than a fronted quantifier, and the "so that" clause recommended elsewhere gains a limit -- 717 of them across the rules and docs is a construction being filled in, not a reason being given. prose-check.py ships beside the SKILL.md it enforces, so the two are versioned and seeded together, and it turns the checkable items into a command over a sweep, the staged lines, or a commit message. Two git hooks run it and neither blocks, both still opt-in through `make -C packaging hooks`. The script header carries the pattern choices. Co-Authored-By: Claude Opus 5 <noreply@anthropic.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
1 participant
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.
Occam's razor was stated in five places, so the skill broke the rule it teaches; it now has one heading. Examples lead with the good form, a negation takes
does notrather than a fronted quantifier, and the "so that" clause recommended elsewhere gains a limit -- 717 of them across the rules and docs is a construction being filled in, not a reason being given.prose-check.py ships beside the SKILL.md it enforces, so the two are versioned and seeded together, and it turns the checkable items into a command over a sweep, the staged lines, or a commit message. Two git hooks run it and neither blocks, both still opt-in through
make -C packaging hooks. The script header carries the pattern choices.