Repository navigation
docs: help contributors explain gogcli changes - #1341
Conversation
Co-authored-by: hannesrudolph <49103247+hannesrudolph@users.noreply.github.com>
Worked on by: - @hannesrudolph Co-authored-by: hannesrudolph <49103247+hannesrudolph@users.noreply.github.com> OpenClaw-Publication: 15b6d941-ae0c-4d3a-8ab0-e839259595fb
|
🦞👀 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 changesAdds a pull request template prompting contributors to explain the problem, impact, approach, and evidence in plain language. Example: A contributor opens a PR about Gmail JSON output.
Review scores
ProductKind: Docs · Worth it: Yes · Fix scope: Complete Merge readiness✅ Ready for maintainer review Keep open: this PR adds useful contributor guidance absent from main, and inspection found no actionable defect. Priority: P3 Before mergeNone. FindingsNone. Agent review detailsHow this fits togetherGitHub uses the repository template to prefill new PR descriptions, which contributors complete for reviewers. flowchart LR
A[Contributor opens PR] --> B[GitHub loads template]
B --> C[Contributor explains change]
C --> D[Reviewer reads description]
Technical reviewBest possible solution: Land the focused template addition while retaining the repository’s existing contribution and release guidance. Do we have a high-confidence way to reproduce the issue? No runtime bug is claimed; the missing default template is directly established by main’s tree. Is this the best way to solve the issue? A single GitHub template is the smallest complete way to provide this guidance, and its illustrative examples match documented gog workflows. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against 9efe5ff47b7d. SecurityNone. EvidenceWhat I checked:
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 16, 2026, 9:25 PM ET / November 17, 2026, 02:25 UTC. |
What Problem This Solves
Contributors currently start gogcli pull requests without a repository or inherited organization template. There is no prompt to explain the affected task and its outcome before implementation details, so a reader may need the diff to understand the proposal.
User Impact
Contributors get guidance for readable titles, concrete problems, relevant impact, and result-first evidence. There is no change to gog commands, flags, output, permissions, or runtime behavior.
Why This Change Was Made
Adds the reader-first template with examples grounded in gogcli's documented JSON-output and Gmail-authorization workflows. Examples are explicitly illustrative, not claims of existing bugs. The change adds no review or testing gate and does not change the release or changelog workflow.
Evidence
make cipassed on AWS Crabbox with Go 1.27.4, including lint (zero issues), Go tests, script tests, documentation coverage, and agent-skill checks. The tested template's hash matches this commit.Validation details
Changed file:
.github/pull_request_template.mdonly.git diff --checkpassed.28d8e6005830f8e2adf380179c4768517859ee9f486af34e9b247798b152c751.cbx_103106637486.run_73426a4c414e1706163caaa75388ccc1;go version && make ciexited 0.run_d54351c5d05f824291426a9ea16e0555; matching hash, no tracked-file changes.--no-hydrateoption. No repository permissions, workflow settings, or checks were changed.Contributor credit: @hannesrudolph requested and directed this change.
Work sessions
Linked for team reference; these sessions aren’t public.
Worked on by