docs: sharpen concision rules for GitHub prose - #23
Merged
Conversation
"Be concise" was too soft to act on: PR bodies restate the summary as test-plan checkboxes and re-sell the same point across paragraphs, and nothing in the skill named that as wrong. Key changes: - Add "say it once" and "cut every word carrying no fact" as Core Principles, with a compress-don't-omit clause so brevity never costs facts - Add matching rows to the PR "What to Avoid" table
JoseSzycho
approved these changes
Jul 29, 2026
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
2 participants
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
"Be concise" is in the skill but too soft to act on, so PR bodies restate the summary as test-plan checkboxes and re-sell the same point across paragraphs. Nothing named that as wrong.
This adds two enforceable Core Principles — say it once, and cut every word carrying no fact — plus the matching "What to Avoid" rows. The compress-don't-omit clause is deliberate: fewer words, not fewer facts.
Canonical home for the rule, so repos can point here instead of each carrying its own copy. datum-cloud/network-services-operator#325 is the in-repo variant for a repo that has no skill reference.
Test plan