docs: make PR descriptions plain-language first - #19
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:52 PM ET / 19:52 UTC. ClawSweeper reviewWhat this changesUpdates the pull request template to put plain-language problems and user impact first while keeping risks, required actions, and evidence summaries visible. Merge readiness⛔ Blocked before merge - 1 item remains Keep open: community’s current main still has the older template. This focused update follows the established cross-repository alignment direction and has no blocking findings. Priority: P3 Review scores
Verification
How this fits togetherThe community repository’s pull request template guides contributors when drafting submissions on GitHub. Its prompts shape the explanations and validation evidence reviewers receive. flowchart LR
A[Contributor opens pull request] --> B[Community PR 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 the community template aligned with the reviewed core wording, with concise explanations and visible material risks and evidence. Do we have a high-confidence way to reproduce the issue? Not applicable: this changes documentation prompts rather than repairing a runtime defect; the complete template and introduced diff were inspected. Is this the best way to solve the issue? Yes: updating the existing template preserves the established submission structure and exactly matches the linked, merged core wording. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against 83cd606cdfe0. LabelsLabel changes:
Label justifications:
EvidenceWhat I checked:
Likely related people:
Rating scale
Overall follows the weaker of proof and patch quality. Workflow
|
Related: openclaw/openclaw#146253
What Problem This Solves
Fixes: PR descriptions bury the problem and user impact in technical detail.
User Impact
Contributors get clearer prompts to explain what changes in plain English. No runtime behavior changes.
Why This Change Was Made
Applies the merged plain-English template while keeping important risks, required actions, and evidence visible.
Evidence
The template matches the reviewed core wording exactly. Heading, marker, preservation, and whitespace checks passed. Only the PR template changed.
Verified documentation tree:
5c87d3d4a91e437804db96ee9e9c657bee926710.