Skip to content

docs: help contributors explain gogcli changes - #1341

Merged
roboclaw-bot merged 2 commits into
mainfrom
openclaw/pr-template-rollout-gogcli
Nov 17, 2026
Merged

roboclaw-bot merged 2 commits into
mainfrom
openclaw/pr-template-rollout-gogcli

Conversation

@roboclaw-bot

Copy link
Copy Markdown
Contributor

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

  • Template checks pass: the exact problem prompt is present, all comments are balanced, only the four intended headings render, and evidence guidance puts results before command details.
  • Independent static review found no actionable issues in the exact template content.
  • Full repository make ci passed 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.
  • Live Google-account integration tests were not run; this is a template-only change.
Validation details

Changed file: .github/pull_request_template.md only.

  • Focused structural assertions and git diff --check passed.
  • Template SHA-256: 28d8e6005830f8e2adf380179c4768517859ee9f486af34e9b247798b152c751.
  • AWS Crabbox lease: cbx_103106637486.
  • Successful full gate: run_73426a4c414e1706163caaa75388ccc1; go version && make ci exited 0.
  • Exact tested-content readback: run_d54351c5d05f824291426a9ea16e0555; matching hash, no tracked-file changes.
  • Actions runner registration lacked permission, so the full gate ran on the leased developer image using the supported --no-hydrate option. 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

roboclaw-bot and others added 2 commits November 17, 2026 02:12
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
@clawsweeper

clawsweeper Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

🦞👀
ClawSweeper picked this up.

Pull request received. I will update this pull request when review starts.

ClawSweeper review complete

ClawSweeper finished reviewing this revision. The review result is being finalized.

View the workflow run.

@clawsweeper clawsweeper Bot added clawsweeper:intake:docs Preliminary submission classification; full source review pending. P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR. and removed clawsweeper:intake:docs Preliminary submission classification; full source review pending. labels Nov 17, 2026
@clawsweeper

clawsweeper Bot commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

Codex review: needs maintainer review before merge.

What this changes

Adds 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.

  • Before: The repository supplies no default PR description.
  • After: The description includes four sections with guidance to explain the affected script and verification result.

Review scores

Measure Result What it means
Overall readiness 🐚 platinum hermit (4/6) A focused, correct documentation addition supported by direct inspection and successful current-head checks.
Proof confidence 🐚 platinum hermit (4/6) This documentation-only template needs no shipped CLI proof; the complete Markdown was inspected directly.
Patch quality 🐚 platinum hermit (4/6) No actionable review findings were identified.

Product

Kind: Docs · Worth it: Yes · Fix scope: Complete
User problem: Contributors lack an automatically supplied prompt to explain a change clearly before reviewers inspect its implementation.
Reason: The authorized direction adds focused guidance at the existing GitHub entry point without imposing a new gate.

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
Reviewed head: e1c1a092b126545b81c6c092eddf1695f033c922

Before merge

None.

Findings

None.

Agent review details

How this fits together

GitHub 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]
Loading

Technical review

Best 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.

Security

None.

Evidence

What I checked:

  • Pinned change: The introduced diff adds only the 67-line template; its comments preserve visible risks, distinguish mocked checks from live observations, and prohibit sensitive account contents. (.github/pull_request_template.md:19, e1c1a092b126)
  • Existing repository contract: The root guidance already requests Conventional Commit subjects, scope, testing, and user-facing changes; the template supports those requirements without changing release policy. (AGENTS.md:36, e1c1a092b126)
  • Current-main boundary: Main contains no PR template, and the organization community repository listing contains no inherited template. (.github, 9efe5ff47b7d)
  • Earlier proposal: chore: align pull request template #918 proposed a shared template but was closed unmerged by its author, hannesrudolph; its comments and reviews record no maintainer rejection of templates.
  • Validation and inspection limits: Diff whitespace checks passed and the checkout remains clean; all non-skipped current-head checks completed successfully on the final read. Older AGENTS.md blobs were unavailable locally, so GitHub commit patches supplemented the ownership hunt. (e1c1a092b126)

Preflight source

Source unknown. Source comparison at the observed PR snapshot only. Completion is self-reported; body, policy, tests, execution, and report bytes are not verified.

Labels

Label changes:

  • add P3: This is low-risk contributor documentation with no CLI or runtime changes.
  • add rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🐚 platinum hermit and patch quality is 🐚 platinum hermit.
  • add status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR.

Label justifications:

  • P3: This is low-risk contributor documentation with no CLI or runtime changes.
  • rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🐚 platinum hermit and patch quality is 🐚 platinum hermit.
  • status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR.

Rating scale

6/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.

Workflow

ClawSweeper edits this one comment on every review. Comment @clawsweeper re-review for a fresh review only. Repair and merge execution lanes are retired.

Reviewed November 16, 2026, 9:25 PM ET / November 17, 2026, 02:25 UTC.

@roboclaw-bot
roboclaw-bot merged commit 351e621 into main Nov 17, 2026
15 checks passed
@roboclaw-bot
roboclaw-bot deleted the openclaw/pr-template-rollout-gogcli branch November 17, 2026 02:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant