Skip to content

docs: extend concision rules to GitHub prose #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ecv merged 1 commit into from
Jul 30, 2026
Merged

docs: extend concision rules to GitHub prose #325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,3 +197,16 @@ Key changes:
descriptions, GitHub issues, and comments render as GitHub-flavored markdown —
do not hard-wrap them; let prose reflow naturally and only break lines where
markdown needs it (lists, tables, code fences).

## GitHub PR / Issue / Comment Conventions

The "Be concise" rule above governs responses and code comments. It applies to
GitHub prose too.

- **Say it once.** Do not describe the same behaviour in prose and again in a
checklist, or restate the summary in the test plan. Reference it instead.
- **Lead with the problem** in plain language, then what changed and why. Push
implementation detail into bullets or a follow-up, not the summary.
- **Cut every word carrying no fact.** One dense paragraph beats three that
re-sell the same point. Brevity must not drop facts — compress, do not omit.
- **Don't hard-wrap** prose (see the commit section above).
Loading