docs: guide pull requests with problem-first descriptions - #213
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. Reviewed September 10, 2026, 4:11 PM ET / 20:11 UTC. ClawSweeper reviewWhat this changesAdds a default GitHub pull-request template that guides contributors through the problem, rationale, user impact, and evidence. Merge readiness✅ Ready for maintainer review This is a focused, useful documentation change with no blocking findings. The template is absent from current main, and the earlier proposal was closed without merging. Member-authored work also remains protected from automatic closure. Priority: P3 Review scores
Verification
How this fits togetherDiscrawl's contribution workflow receives proposed changes through GitHub pull requests. The template supplies description prompts that help contributors explain their work to reviewers. flowchart LR
A[Contributor opens pull request] --> B[Default repository template]
B --> C[Problem and rationale]
B --> D[User impact and evidence]
C --> E[Reviewer assessment]
D --> E
Before mergeNone. Agent review detailsSecurityNone. Review metricsNone. Technical reviewBest possible solution: Use one repository-default template to make contribution descriptions consistently explain the problem and supporting evidence. Do we have a high-confidence way to reproduce the issue? Not applicable: this proposes contribution guidance rather than reporting a runtime defect. Is this the best way to solve the issue? Yes: a single default template is a narrow, maintainable way to provide the missing description structure, and the pinned source copy matches exactly. AGENTS.md: not found in the target repository. Codex review notes: model internal, reasoning medium; reviewed against 5ef4faad55d0. LabelsLabel changes:
Label justifications:
EvidenceWhat I checked:
Likely related people:
Rating scale
Overall follows the weaker of proof and patch quality. Workflow
|
Related: #125
Additional instructions
MUST: Keep Allow edits from maintainers enabled for this PR so maintainers
can help update the branch when needed.
What Problem This Solves
Discrawl contributors and reviewing agents need PR descriptions that explain the concrete problem before the implementation. Without a consistent starting structure, descriptions can lead with code changes and leave reviewers to reconstruct why the change matters, who benefits, and what evidence supports it.
Why This Change Was Made
Add OpenClaw's current default pull-request template unchanged at GitHub's standard
.github/pull_request_template.mdlocation. It provides the four problem-first sections, optional linked-context guidance, user-facing title guidance, and the reminder to keep maintainer edits enabled.The identical template was previously proposed in #125, which was closed without merging. Discrawl still has no default PR template; this proposal adds the current canonical template.
User Impact
Contributors opening new PRs through GitHub receive a problem-first description structure. Agents and command-line contributors can use the same repository template, and reviewers get consistent sections for the problem, rationale, impact, and evidence.
This is contributor-workflow guidance; there is no change to Discrawl's CLI, archive data, or runtime behavior.
Evidence
4ae4b5c.e902c4789b21765ea16dfb75e436db5801b6450b.git diff --checkpassed.