From 9c1bebc84b51e701c0d42d0826bcb24452f8bf52 Mon Sep 17 00:00:00 2001 From: Evan Vetere Date: Tue, 4 Aug 2026 21:35:35 -0400 Subject: [PATCH] docs: point GitHub conventions at the shared skill The rules for pull requests and issues were copied here and had drifted from the shared skill, and none of the copy named a limit anyone could check. The skill now carries a countable bar and a hook that blocks a post missing it, so this file keeps a pointer rather than a second statement of the rules. --- CLAUDE.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 1dc12006..1e947ba8 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -200,13 +200,11 @@ Key changes: ## 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). +The `datum-platform:pr-conventions` skill owns these rules for every repo, and +this one adds nothing. Read it before drafting GitHub content. + +It carries the countable bar — a four-sentence summary, a four-checkbox test +plan, no file paths or identifiers in the opening post, no hard-wrapped prose — +and the writing rules behind it. The skill's `pr-op-gate` hook measures a body +on `gh pr|issue create|edit` and blocks the post when it misses, naming the rule +and the count that broke it.