Skip to content

docs: extend concision rules to GitHub prose - #325

Merged
ecv merged 1 commit into
mainfrom
docs/github-prose-brevity
Jul 30, 2026
Merged

docs: extend concision rules to GitHub prose#325
ecv merged 1 commit into
mainfrom
docs/github-prose-brevity

Conversation

@ecv

@ecv ecv commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

CLAUDE.md says "Be concise. Always", but scopes it to responses and code comments. PR descriptions and issue bodies fall outside it, and it shows: summaries restated verbatim as test-plan checkboxes, and several paragraphs re-selling the same point.

This extends the rule to GitHub prose and names the failure modes, next to the hard-wrap scope note from #323.

The compress-don't-omit clause is deliberate — the goal is fewer words, not fewer facts.

Test plan

  • Docs-only change; no code paths touched

The "Be concise" rule was scoped to responses and code comments, so PR
descriptions and issue bodies kept accumulating restated summaries and
checklists that duplicated prose already above them.

Extend the rule to GitHub prose and name the specific failure modes,
alongside the existing hard-wrap scope note.

Key changes:
- Add a GitHub PR / Issue / Comment Conventions section
- Require saying things once, leading with the problem, and cutting words
  that carry no fact, while compressing rather than omitting
@ecv
ecv merged commit afdff9a into main Jul 30, 2026
11 checks passed
@ecv
ecv deleted the docs/github-prose-brevity branch July 30, 2026 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants