docs: make PR descriptions plain-language first - #72
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:49 PM ET / 19:49 UTC. ClawSweeper reviewWhat this changesThe PR shortens contributor guidance, 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, useful template improvement that is absent from current main. No actionable correctness or security defects were found. Priority: P3 Review scores
Verification
How this fits togetherThis repository stores OpenClaw design proposals. Its GitHub PR template guides contributors from describing a problem through explaining impact, rationale, and validation for reviewers. flowchart LR
A[Contributor opens PR] --> B[PR description template]
B --> C[Problem and user impact]
B --> D[Rationale and evidence]
C --> E[Reviewer assessment]
D --> E
Before merge
Agent review detailsSecurityNone. Review metricsNone. Technical reviewBest possible solution: Use the shorter template to foreground outcomes while retaining explicit risk, required-action, and validation guidance. Do we have a high-confidence way to reproduce the issue? Not applicable: this changes PR authoring guidance and does not report a runtime defect. Is this the best way to solve the issue? Yes: editing the existing template is a narrow solution, and the patch preserves its section names and contribution requirements. AGENTS.md: not found in the target repository. Codex review notes: model internal, reasoning medium; reviewed against 967d9aac7472. 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.