Repository navigation
docs: help PR authors explain the affected task and outcome - #161
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 changesThis PR adds examples and prompts asking contributors to explain the affected task, outcome, and validation result in plain language. Example: A contributor describes a remote desktop connection error change.
Review scores
ProductKind: Docs · Worth it: Yes · Fix scope: Complete Merge readiness✅ Ready for maintainer review Keep this maintainer-authored draft open; its documentation changes are coherent, and inspection found no actionable defect. Priority: P3 Before mergeNone. FindingsNone. Agent review detailsHow this fits togetherGitHub loads the Markdown template into new PR descriptions, where its comments guide contributors before reviewers read the resulting submission. flowchart LR
A[Template Markdown] --> B[GitHub PR editor]
B --> C[Contributor description]
C --> D[Maintainer review]
Technical reviewBest possible solution: Retain the repository-specific examples and validation guidance while preserving the existing template structure. Do we have a high-confidence way to reproduce the issue? There is no runtime bug to reproduce; the original and revised Markdown directly establish the wording changes. Is this the best way to solve the issue? Editing the existing template is an appropriate solution, although some added prompts repeat guidance already present. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against 49683e8c093e. 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 17, 2026, 11:37 AM ET / 16:37 UTC. |
What Problem This Solves
The current PR template does not clearly ask authors to lead with the affected task and outcome or summarize validation before commands.
User Impact
Contributors and reviewers get reader-first title, problem, and evidence prompts. There is no application-runtime change.
Why This Change Was Made
Applies the wording guidance from openclaw/openclaw#200319 with repository-specific examples. Preserves every existing heading and checklist item, existing privacy/security sections, and the optional Fixes prompt wherever present. No tests, review gates, permissions, or runtime settings are added.
Evidence
Read the current remote instructions and template. Checked balanced Markdown comments, whitespace, preservation of existing headings/checklist items, and retained contract wording. Publication uses one GitHub CLI mutation and changes only
.github/pull_request_template.md; no clone, worktree, or local file is created. Runtime tests, dependency-backed validation, and independent review were not run by this API-only publication; existing required checks/reviews remain outstanding, not waived.The prior Team candidate reported unmet local validation gates, missing dependencies/Go, and test failures. Those are retained limitations, not passing evidence. This draft does not claim the gates were resolved.