Repository navigation
docs: help PR reviewers understand the problem before the fix - #335
Conversation
|
🦞👀 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 maintainer review before merge. What this changesExpands the PR template’s problem-statement guidance with affected-user prompts and contrasting problem-versus-fix examples. Example: A contributor describes a change to background checks.
Review scores
ProductKind: Docs · Worth it: Yes · Fix scope: Complete Merge readiness✅ Ready for maintainer review Keep this PR open: it is a useful maintainer-authored documentation change absent from main, with no actionable defects found. Priority: P3 Before mergeNone. FindingsNone. Agent review detailsHow this fits togetherGitHub seeds new PR descriptions from this Markdown template; contributors read its comments and supply the problem, impact, approach, and evidence for reviewers. flowchart LR
A[Contributor opens PR] --> B[GitHub loads template]
B --> C[Contributor reads guidance]
C --> D[Contributor writes description]
D --> E[Reviewer assesses problem and fix]
Technical reviewBest possible solution: Land the focused guidance in the existing template while preserving its visible structure and illustrative-example caveat. Do we have a high-confidence way to reproduce the issue? There is no runtime bug to reproduce; the complete base and head templates directly establish the editorial difference. Is this the best way to solve the issue? The existing template is the appropriate owner, and the focused edit clarifies the problem statement without introducing machinery or review gates. AGENTS.md: found, but no applicable review policy affected this item. Codex review notes: model internal, reasoning medium; reviewed against 8e42adba0f87. Provenance checked
SecurityNone. EvidenceWhat I checked:
Likely related people:
Preflight sourceSource unknown. Source comparison at the observed PR snapshot only. Completion is self-reported; body, policy, tests, execution, and report bytes are not verified. LabelsLabel changes:
Label justifications:
Rating scale6/6 🦀 challenger crab · 5/6 🦞 diamond lobster · 4/6 🐚 platinum hermit · 3/6 🦐 gold shrimp · 2/6 🦪 silver shellfish · 1/6 🧂 unranked krab. Overall follows the weaker of proof and patch quality; ✨ marks media proof (a screenshot, video, or linked artifact) that directly shows the changed behavior. WorkflowClawSweeper edits this one comment on every review. Comment Reviewed November 21, 2026, 6:22 PM ET / 23:22 UTC. |
What Problem This Solves
A PR can describe the fix in plain language without telling reviewers who is affected, what happens today, or why it matters. That leaves reviewers guessing at the problem before they can judge the fix.
User Impact
The template asks authors to describe the problem independently of the fix and shows the difference with a good and bad example. There is no runtime change.
Why This Change Was Made
This brings the problem-statement guidance from openclaw/openclaw#202682 into the template updated in #332. The rest of the template stays as it is.
Evidence
Verified that only the problem-guidance comment changes and that all text outside HTML comments is unchanged. No runtime tests were run for this template-only change.