Skip to content

docs: sharpen concision rules for GitHub prose #23

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 29, 2026
Merged

docs: sharpen concision rules for GitHub prose #23

Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Notable changes to the Datum Cloud Claude Code plugins.

## [1.8.2] - 2026-07-29

### Changed

- **GitHub conventions skill** (`pr-conventions`, datum-platform) — Sharpened "be concise" into two enforceable rules: say it once (no restating the summary as test-plan checkboxes, no describing the same behaviour in prose and again in a checklist) and cut every word carrying no fact, with a compress-don't-omit clause so brevity never costs facts. Added the two matching rows to the PR "What to Avoid" table.

## [1.8.1] - 2026-07-09

### Changed
Expand Down
2 changes: 1 addition & 1 deletion plugins/datum-platform/.claude-plugin/plugin.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "datum-platform",
"description": "Kubernetes platform engineering automation with aggregated API servers, controller patterns, GitOps deployment, and platform capabilities",
"version": "1.8.1",
"version": "1.8.2",
"author": {
"name": "Datum Cloud",
"url": "https://github.com/datum-cloud"
Expand Down
5 changes: 4 additions & 1 deletion plugins/datum-platform/skills/pr-conventions/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ This skill covers how to work with GitHub effectively — writing pull requests,
## Core Principles

- Write for humans, not machines. Avoid jargon unless the audience is explicitly technical.
- Be concise. Respect the reader's time.
- **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.
- **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.
- Focus on goals and outcomes, not implementation details.
- Use comments to add depth — keep the primary description focused.
- Close issues deliberately. Linking is not closing.
Expand Down Expand Up @@ -112,6 +113,8 @@ Write like you're explaining the change to a teammate. Non-technical stakeholder
| PRs without an issue link | Every change should trace to intent |
| Technical jargon in summaries | Not all readers have the same context |
| Bullet-point-only summaries | Lead with prose for orientation |
| Test-plan items that restate the summary | The test plan says what you verified, not what you wrote |
| Paragraphs re-selling a point already made | Say it once, densely |
| Hard-wrapping prose at a fixed column | GitHub reflows Markdown — wrap only where syntax requires |
| Tool attribution / watermarks | Clutters the PR |
| Empty sections | Omit optional sections rather than leaving them blank |
Expand Down