docs: keep issues and PR descriptions concise and concrete - #13257
Conversation
|
Warning Review limit reachedNext included review available in 4 minutes. View limit detailsLimit 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. Review configuration: ⚙️ Run configurationConfiguration used: Repository: manaflow-ai/cmux/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (4)
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. Comment |
|
All contributors have signed the CLA ✍️ ✅ |
|
Preserve the contributor verification ladder alongside the writing guide pointer.
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)
CMUX issues and PRs often bury the concrete change under implementation detail or accumulated status updates. Add a short
STYLE.mdfor 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 --checkpasses. 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, andCLAUDE.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.