Repository navigation
docs: guide contributors toward reader-first PR descriptions - #332
Conversation
Add ClickClack reconnect examples and result-first evidence guidance while preserving the local template contracts and visible content. 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: 0b809421-9da1-4d02-9b2d-ac564dd78951
|
🦞👀 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 reader-first writing guidance and illustrative reconnect examples to the pull request template. Example: A contributor describes a reconnect fix.
Review scores
ProductKind: Docs · Worth it: Yes · Fix scope: Complete Merge readiness✅ Ready for maintainer review This PR is a focused, useful documentation update with no actionable defects; its added guidance is absent from current main. Priority: P3 Before mergeNone. FindingsNone. Agent review detailsHow this fits togetherGitHub seeds new pull request descriptions from this Markdown template; contributors use its comments to explain the problem, impact, approach, and evidence. flowchart LR
A[Contributor opens PR] --> B[GitHub loads template]
B --> C[Contributor reads guidance]
C --> D[Contributor writes description]
D --> E[Reviewer assesses change]
Technical reviewBest possible solution: Land the focused template guidance while retaining its existing visible content and illustrative-example caveats. Do we have a high-confidence way to reproduce the issue? There is no runtime bug to reproduce; the complete diff directly exposes the editorial change. Is this the best way to solve the issue? The existing template is the appropriate owner, and the change preserves its structure without adding machinery or review gates. AGENTS.md: found, but no applicable review policy affected this item. Codex review notes: model internal, reasoning medium; reviewed against 49f20b05aeb9. Provenance checked
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, 11:44 PM ET / November 17, 2026, 04:44 UTC. |
Maintainer edits
MUST: Keep Allow edits from maintainers enabled for this PR so maintainers
can help update the branch when needed.
What Problem This Solves
ClickClack contributors need examples that explain a chat workflow and its outcome without assuming the reader knows the implementation.
User Impact
User impact: contributors get concrete examples for clear problem, impact, and evidence summaries; reviewers can distinguish observed results from untested paths. This changes PR guidance only, not chat behavior.
Why This Change Was Made
The existing template already leads with the problem and user impact. This adds reader-first guidance and illustrative reconnect examples while retaining its prompts, headings, visible content, and maintainer-edit requirement. No new review or test gates are introduced.
Evidence
The template contract check passed: all noncomment bytes, four headings, five comment boundaries, and existing guidance are unchanged except for two title examples adapted from task queries to channel reconnects. Only the template changed, and
git diff --checkpassed.An independent read-only review found no actionable issues and verified the same template hash and local contracts. ClawSweeper's exact-head review also reported no findings or before-merge fixes.
Hosted checks passed for head
6f98dcb6d6be75261b8d260a646a0bc2909fe89d: Go, TypeScript, Node 24 compatibility, Playwright E2E, Docker, all three desktop packages, CodeQL, and dispatch (13 successes). Four event-dispatch jobs and the optional Windows signing qualification were skipped.Application tests were not run locally because this is comment-only Markdown; no reconnect behavior is claimed to have been tested by this task.
Requested by and co-authored with @hannesrudolph.
Work sessions
Linked for team reference; these sessions aren’t public.
Worked on by