docs: make PR descriptions plain-language first - #3690
Conversation
Co-authored-by: hannesrudolph <49103247+hannesrudolph@users.noreply.github.com>
|
🦞👀 Pull request received. I will update this pull request when review starts. ClawSweeper review completeClawSweeper finished reviewing this revision. The review result is being finalized. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Found 2 test failures on Blacksmith runners: Failures
|
|
Codex review: needs real behavior proof before merge. Reviewed September 12, 2026, 3:40 PM ET / 19:40 UTC. ClawSweeper reviewWhat this changesThe PR shortens contributor prompts, places user impact before implementation rationale, and asks authors to keep risks and evidence summaries visible. Merge readiness⛔ Blocked before merge - 1 item remains Keep open: this is a focused documentation improvement that is not yet on ClawHub main. No blocking findings. Priority: P3 Review scores
Verification
How this fits togetherClawHub’s GitHub PR template guides contributors when writing a proposed change’s description. Its prompts turn contributor context into problem, impact, rationale, and evidence sections for reviewers. flowchart LR
A[Contributor opens PR] --> B[PR template]
B --> C[Problem and user impact]
B --> D[Rationale and evidence]
C --> E[Reviewer assessment]
D --> E
Before merge
Agent review detailsSecurityNone. Review metrics
Technical reviewBest possible solution: Keep concise problem-and-impact prompts in the existing template while preserving visible risk summaries and meaningful validation evidence. Do we have a high-confidence way to reproduce the issue? Not applicable: this changes editorial guidance rather than repairing a runtime defect; the complete template diff establishes the behavior being changed. Is this the best way to solve the issue? Yes. Editing the existing template is the best location because contributors encounter it while drafting; expanding CONTRIBUTING.md would add a separate reading step and duplicate guidance. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against 8c2de6c506bb. LabelsLabel changes:
Label justifications:
EvidenceWhat I checked:
Likely related people:
Rating scale
Overall follows the weaker of proof and patch quality. Workflow
|
What Problem This Solves
Contributors need a shorter, clearer way to explain their changes before implementation details.
User Impact
User impact: contributors are prompted to state the problem and concrete outcome first. No product behavior changes or migration steps.
Why This Change Was Made
Applies the plain-language template from openclaw/openclaw#146253 while preserving section names, maintainer edits, and evidence requirements.
Evidence
git diff --checkpassed; only the PR template changed. No runtime tests run for this documentation-only change.