Repository navigation
docs: help readers understand plugin-inspector PRs without reading code - #158
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: 64062aa9-341a-85a0-a16d-06d68a6afa63
|
🦞👀 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 replaces generic writing examples with plugin-specific guidance and asks contributors to explain validation results before technical details. Example: A contributor describes a manifest diagnostic improvement.
Review scores
ProductKind: Docs · Worth it: Yes · Fix scope: Complete Merge readiness✅ Ready for maintainer review Keep open: this PR provides a focused, useful template improvement absent from main, with no actionable findings. Priority: P3 Before mergeNone. FindingsNone. Agent review detailsHow this fits togetherGitHub inserts this Markdown template into new PR descriptions, where contributors use its comments to explain their change to reviewers. flowchart LR
A[Template comments] --> B[GitHub PR editor]
B --> C[Contributor description]
C --> D[Reviewer understanding]
Technical reviewBest possible solution: Land the focused template wording while preserving its existing submission structure and review requirements. Do we have a high-confidence way to reproduce the issue? No runtime bug is claimed; the base template directly confirms the generic examples and existing evidence wording. Is this the best way to solve the issue? Updating the existing template is the smallest complete solution, with no parallel policy document, automation, or runtime changes. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against 21f4a33c3607. 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 16, 2026, 8:24 PM ET / November 17, 2026, 01:24 UTC. |
What Problem This Solves
People reviewing a plugin-inspector pull request should be able to understand who needs the change and why without knowing its implementation. The current template's generic examples focus on unrelated application behavior, and its evidence guidance can leave readers decoding commands rather than seeing what was verified.
User Impact
Contributors get examples about plugin authors checking package compatibility, plus guidance to explain the affected task, missing need or failure, and why it matters. This changes PR-writing guidance only; runtime behavior and existing review requirements are unchanged.
Why This Change Was Made
Adapt the reader-first guidance from openclaw/openclaw#200319 to this repository. Paired good/bad examples distinguish experienced problems from implementation details, including real internal workflows without invented end-user benefits.
Evidence
The template retains every heading and all non-comment content byte-for-byte. The exact concrete-problem prompt is also preserved. Only the recognized PR template changed; balanced-comment and whitespace checks passed. Evidence guidance now asks for checked behavior and observed results before commands, hashes, or logs. No runtime test result is claimed for this comments-only change.
Contributed with @hannesrudolph.
Work sessions
Linked for team reference; these sessions aren’t public.
Worked on by