Skip to content

docs: keep issues and PR descriptions concise and concrete - #13257

Merged
teamleaderleo merged 2 commits into
mainfrom
docs/public-writing-style
Sep 20, 2026
Merged

teamleaderleo merged 2 commits into
mainfrom
docs/public-writing-style

Conversation

@teamleaderleo

@teamleaderleo teamleaderleo commented Sep 20, 2026 •

Copy link
Copy Markdown
Collaborator

CMUX issues and PRs often bury the concrete change under implementation detail or accumulated status updates. Add a short STYLE.md for public writing, using recent CMUX descriptions as examples.

The guide covers leading with user/caller behavior, proportional detail, precise validation claims, current status, and decidable proposals. Link it from contributor guidance, agent instructions, and the PR template. Existing engineering and merge requirements are unchanged.

Validation: reviewed the Markdown and links; git diff --check passes. Documentation only, so no runtime tests or demo apply.


Summary by cubic

Adds STYLE.md, a short public writing guide for CMUX issues, RFCs, and PRs, so descriptions lead with the concrete behavior change and base claims on precise evidence. Links it from the PR template, CONTRIBUTING.md, and CLAUDE.md, while keeping the existing contributor verification ladder in place. Documentation only; no runtime or review process changes.

Written for commit 3d88c82. Summary will update on new commits.

Review in cubic

@coderabbitai

coderabbitai Bot commented Sep 20, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 4 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 10 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: manaflow-ai/cmux/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: a8dabaa5-3a60-4f63-b84b-fd3f50809fe7

📥 Commits

Reviewing files that changed from the base of the PR and between 95fdfd7 and 3d88c82.

📒 Files selected for processing (4)
  • .github/pull_request_template.md
  • CLAUDE.md
  • CONTRIBUTING.md
  • STYLE.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@greptile-apps

greptile-apps Bot commented Sep 20, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

The documentation-only PR appears safe to merge, with no actionable issues identified.

Summary

Adds STYLE.md with concise writing guidance for issues, RFCs, PR descriptions, and progress updates.

  • Emphasizes concrete behavior, proportional detail, precise validation claims, and current status.
  • References the guide from contributor instructions, agent instructions, and the PR template while preserving existing engineering and approval requirements.
  • Changes since the previous review only merge existing main-branch updates. No actionable new issues or repository-rule violations were identified.
  • git diff --check passes. No runtime tests were run for this documentation-only PR.

Reviews (2) · Last reviewed commit: "Merge main into docs/public-writing-styl..."

Preserve the contributor verification ladder alongside the writing guide pointer.
@teamleaderleo
teamleaderleo enabled auto-merge (squash) September 20, 2026 18:16
@teamleaderleo
teamleaderleo merged commit 55092b9 into main Sep 20, 2026
37 of 38 checks passed
rustybret pushed a commit to rustybret/bmux that referenced this pull request Sep 20, 2026
e77a6b1 feat: add current-work reads and Find Work (manaflow-ai#13269)
6386ba5 Cache Ghostty CLI helper builds across local invocations (manaflow-ai#13206)
8f6c0ea ci: measure compiled test artifact transfer cost (manaflow-ai#13172)
55092b9 docs: add a concise guide for public CMUX writing (manaflow-ai#13257)
9e7d3be fix(web): preserve locale preference during prefetch (manaflow-ai#13255)
b093335 build: skip unchanged diff sidecar builds (manaflow-ai#13212)
b79d77d perf: skip unchanged bundled resource builds (manaflow-ai#13209)
4c19fcb feat: expose stable surface and workspace IDs in catalog reads (manaflow-ai#13247)
95fdfd7 ci: add safe stale run janitor (manaflow-ai#13143)
0bcf003 docs: make the contributor verification ladder explicit (manaflow-ai#13242)
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.

1 participant