Repository navigation
docs: make PR descriptions plain-language first - #77
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. |
|
Codex review: needs real behavior proof before merge. Reviewed September 12, 2026, 3:50 PM ET / 19:50 UTC. ClawSweeper reviewWhat this changesThe PR template asks contributors to describe the problem and user impact first, keep technical explanations brief, and summarize evidence and important risks visibly. Merge readiness⛔ Blocked before merge - 1 item remains This is a useful, focused wording improvement that is not yet on main. No actionable correctness or security defect was found. Priority: P3 Review scores
Verification
How this fits togetherGitHub uses this template to seed new pull request descriptions. Its prompts guide contributors toward information reviewers need to understand the change and its validation. flowchart LR
A[Contributor opens PR] --> B[Description template]
B --> C[Problem and user impact]
B --> D[Rationale and evidence]
C --> E[Maintainer review]
D --> E
Before merge
Agent review detailsSecurityNone. Review metricsNone. Technical reviewBest possible solution: Keep a concise problem-first template with stable headings and visible summaries of impact, risks, required actions, and evidence. Do we have a high-confidence way to reproduce the issue? Not applicable: this changes editorial guidance rather than repairing a runtime defect. Is this the best way to solve the issue? Yes: updating the existing template preserves its structure and avoids a competing contribution workflow. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against 2e21b3b48aa0. 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
PR authors need clearer guidance to explain the problem and outcome without a long technical introduction.
User Impact
User impact: contributors are prompted to put the concrete outcome first and keep risks, migrations, required actions, and useful evidence visible. No product behavior changes.
Why This Change Was Made
Carry over the approved wording from openclaw/openclaw#146253 while preserving the existing section names and maintainer-edit requirement.
Evidence
git diff --checksuccessfully.