Skip to content

docs: make local review scope and outcomes explicit - #1800

Closed
bkudiess wants to merge 1 commit into
openclaw:mainfrom
bkudiess:bkudiess-w4-review-invocation-guide
Closed

bkudiess wants to merge 1 commit into
openclaw:mainfrom
bkudiess:bkudiess-w4-review-invocation-guide

Conversation

@bkudiess

Copy link
Copy Markdown
Collaborator

What Problem This Solves

Fixes: local source reviews can be described as whole-PR or clean when the selected comparison or final results do not support that claim.

User Impact

User impact: contributors get an explicit P0-P3 review recipe and honest interpretation of final outputs; there is no product UI or runtime change. The Python example requires PowerShell 7.3+, Windows/Standard native argument passing, and a native Python executable rather than a batch shim.

Why This Change Was Made

Keep the canonical shared reviewer authoritative while documenting mode/base/index/worktree scope, unique external outputs, final JSON/status/exit checks, context/image/platform limits, narrative fallback, and optional genuine preflight. No Windows wrapper or new receipt schema is introduced. Commit mode is explicitly limited to non-merge commits. The disputed suggestion to persist console output is not included.

Evidence

Source checked against shared agent-skills 1444c91f6b455227993bc780d0933f78ae54f5b4, including parser, commit-parent rejection, status derivation, and separate output publication. Local helper-source SHA-256 is 7C8CC65E83BD47A333143D74BC2CD24CCD37888436578F98B0290609D1640FF8; source inspection is not helper execution or installed-copy parity.

Independent Opus 5.5 and GPT-6 Astra narrative reviews found two P3 documentation defects, both fixed. Focused delta review found a tightly coupled batch-shim gap, also fixed. Both final delta reviews report no remaining P0-P3 findings in the correction scope. Host-reported IDs were claude-opus-5.5 and gpt-6-astra; high reasoning was requested for both, long context for Astra. Effective settings were not independently attested. Original reviewer contexts were unavailable for corrections, so fresh narrow delta contexts were used, then retained for final closure. This does not renew broad review coverage or imply helper-owned isolation/status.

The reviewed dirty candidate was based on 5c66a7d35ef328c2487df6e4d86ed92d4cc5942d. Commit b8c718a56a87130b026e9264b6929a8f0cb84d4e contains exactly the same two reviewed file byte sequences: skill SHA-256 FD0D9D80ED566E1A8D0999D100BC4B4AD11F73622931531BFAFCDBB6CA70E12B; workflow SHA-256 D46AF80AAF94BE58C77B25C02EE5C21A0BDC2C1C6C38BACE164CE6F2532C4A21. The commit changes candidate identity; prior narrative review is described by byte correspondence, not restamped as a committed helper receipt. Checks below were rerun on this exact commit. Private transcripts and session artifacts are not uploaded as public proof.

Change Type

  • Bug fix
  • Feature
  • Refactor
  • Docs or instructions
  • Tests or validation
  • Security hardening
  • Chore or infrastructure

Scope

  • Tray or WinUI UX
  • Windows node capability
  • Local MCP or winnode
  • Gateway, connection, or pairing
  • Setup or onboarding
  • Permissions, privacy, or security
  • Tests, CI, or docs

Required proof pools

  • none: documentation and skill guidance only; no product, shipped winnode command-reference, UI, Gateway, installer, or native-host behavior changed.

Validation

On b8c718a56a87130b026e9264b6929a8f0cb84d4e:

Exact command Result
.\scripts\validate-docs.ps1 Passed, exit 0: 63 Markdown files; 7 named pools in each schema path; documentation flow regression 4.15s
.\scripts\validate-agent-skills.ps1 Passed, exit 0: 11 skills and 20 Markdown files
git diff --check Passed, exit 0; committed worktree clean
& '<private-session-artifacts>\w4-correction-contract.ps1' Passed, exit 0: 2 PowerShell blocks parsed, 5 simulated version/mode guard cases, 3 extracted executable-extension guard cases, 6 local stdlib argv probes, pinned merge-rejection source check. Private scratch harness, not a shipped repository command.

The argument probes use only Python json/sys.argv, not the reviewer or provider. An earlier artifact-only harness attempted to shadow read-only PSVersionTable and failed; the simulation was corrected to substitute a test version expression. All final checks passed after that correction. Full build and Shared/Tray tests were not run because this is prose-only, per the documentation validation route. No new installation, shared helper/version/dry-run, full example, provider/model CLI, or app/runtime was executed for publication. No CI result is claimed.

Real Behavior Proof

  • Environment tested: Windows, PowerShell 7.6.7, resolved native Python executable.
  • PR head or commit tested: b8c718a56a87130b026e9264b6929a8f0cb84d4e.
  • Exact steps or command run: the private scratch contract command above parsed the current document, extracted its guards, checked simulated versions/modes and .exe/.bat/.cmd paths, then invoked resolved Python with -c 'import json,sys; print(json.dumps(sys.argv[1:]))' --prompt <synthetic-requirements> --output <synthetic-path> under both Windows and Standard argument modes. The probe only echoed arguments; it created no output report.
  • Evidence after fix: copied output: PASS: 2 PowerShell blocks parsed; 5 extracted-version/mode cases; 3 extracted-exe guard cases; 6 argv preservation probes; merge rejection source check.
  • Observed result: embedded double quotes, spaces, and trailing backslash survived, and the following output flag/path stayed separate. .exe accepted; .bat/.cmd rejected in the extracted guard. Merge restriction matches pinned helper source.
  • Screenshot or artifact links verified? (Yes/No/N/A) N/A; no media or private artifacts uploaded.
  • Not verified or blocked: no actual PowerShell 5.1/7.2/7.3 runtime was exercised; older-version cases were simulations. No full helper/example execution, provider authentication, native isolation, selected-installation parity, third-party executable-wrapper forwarding, UI/MCP/Gateway proof, or complete agent-decision benchmark is claimed. A bounded conventional-path check found no shared installation; custom installation availability remains unknown.

Security Impact

  • New permissions or capabilities? (Yes/No) No
  • Secrets or tokens handling changed? (Yes/No) No
  • New or changed network calls? (Yes/No) No
  • Command or tool execution surface changed? (Yes/No) No product surface changed; documentation now constrains the example's shell/interpreter prerequisites.
  • Data access scope changed? (Yes/No) No
  • If any answer is Yes, explain the risk and mitigation: N/A.

Compatibility and Migration

  • Backward compatible? (Yes/No) Yes for product behavior; the documented Python example explicitly does not support legacy PowerShell argument passing or batch shims.
  • Config or environment changes? (Yes/No) No automatic changes. The example requires PowerShell 7.3+ with Windows/Standard passing and native Python 3.10+.
  • Migration needed? (Yes/No) No
  • If yes, list the exact upgrade steps: N/A; no installation is performed or implicitly authorized.

Review Conversations

  • I replied to or resolved every bot review conversation addressed by this PR.
  • I left unresolved only conversations that still need maintainer judgment.

No existing PR review conversations were addressed; this is a new draft PR. No merge or auto-merge is requested.

Document the shared reviewer invocation, result-reading boundaries and honest fallback. Require safe native PowerShell argument handling and state the non-merge commit limit.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: f44c82c5-1366-4233-9691-48f66ab81984
@clawsweeper

clawsweeper Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

🦞👀
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 Oct 21, 2026
@clawsweeper

clawsweeper Bot commented Oct 21, 2026

Copy link
Copy Markdown

Codex review: needs maintainer review before merge.

What this changes

The PR documents explicit review scope, safe Windows invocation, result interpretation, and fallback limits for the shared reviewer.

Example: A contributor reviews branch commits plus uncommitted changes against the intended target.

  • Before: The local entrypoint specifies P0-P3 severity but provides no complete invocation or final-output interpretation recipe.
  • After: The guide pins the merge base, selects local mode with --max-priority P3, allocates fresh external outputs, and checks status alongside the report and exit.

Review scores

Measure Result What it means
Overall readiness 🐚 platinum hermit (4/6) Useful documentation supported by authoritative source inspection and passing exact-head documentation CI, with no actionable findings.
Proof confidence 🌊 off-meta tidepool Not applicable: Documentation-only change: the body supplies current-head PowerShell argument probes and clearly limits their claims; no full helper, provider or product execution is represented as completed.
Patch quality 🐚 platinum hermit (4/6) No actionable review findings were identified.

Product

Kind: Docs · Worth it: Yes · Fix scope: Complete
User problem: Contributors can overstate review coverage or cleanliness when they misunderstand the selected comparison or final outputs.
Reason: The collaborator-authored direction has owner authorization and addresses a concrete documentation gap while preserving the shared reviewer and existing fallback.

Merge readiness

✅ Ready for maintainer review

Keep open: this collaborator-authored PR adds useful guidance absent from current main, and source review found no actionable introduced defects.

Priority: P3
Reviewed head: b8c718a56a87130b026e9264b6929a8f0cb84d4e

Before merge

None.

Findings

None.

Agent review details

How this fits together

Repository agent instructions route contributors to the separately installed shared reviewer, which consumes a selected Git comparison and context and produces review reports and status.

flowchart LR
  A[Contributor task] --> B[Repository review entrypoint]
  B --> C[Windows invocation guide]
  C --> D[Shared reviewer]
  D --> E[Report and status]
  E --> F[Scoped assessment]
Loading

Technical review

Best possible solution:

Retain the source-backed local recipe while keeping reviewer implementation and result contracts owned by the shared skill.

Do we have a high-confidence way to reproduce the issue?

This is documentation clarification; the shorter main-branch guidance and the helper's distinct comparison modes are directly source-verifiable.

Is this the best way to solve the issue?

The approach fits the existing ownership boundary, links the authoritative implementation, and distinguishes source checks, narrative review and helper execution without adding local machinery.

AGENTS.md: found and applied where relevant.

Codex review notes: model internal, reasoning medium; reviewed against 489208e06780.

Provenance checked

  • Shared reviewer ownership and installation keeps the original intent (0c6e586: Retire drifting repository-local copies and retain a canonical shared installation.)
  • Copilot fallback and P0-P3 review keeps the original intent (d6fe320: Allow independent review through Copilot without requiring a separate Codex CLI while preserving severity and honest limitation reporting.)
  • Agent workflow and evidence guidance keeps the original intent (3977f82: Route agents to the correct owners and evidence without mistaking incomplete or stale validation for completed proof.)

Security

None.

Evidence

What I checked:

  • Verified introduced change: The pinned introduction changes only the review skill entrypoint and workflow guide; the verified test merge contains those same two paths. (docs/AGENT_WORKFLOWS.md:36, b8c718a56a87)
  • Current main and original intent: Current main retains the shorter guidance. The PR preserves shared ownership established by chore(autoreview): use the shared canonical skill #1599 (chore(autoreview): use the shared canonical skill) and the fallback established by docs: allow Copilot autoreview when Codex CLI is unavailable #1730 (docs: allow Copilot autoreview when Codex CLI is unavailable). (.agents/skills/autoreview/SKILL.md:8, 489208e06780)
  • Authoritative dependency contract: The guide explicitly invokes this repository's helper and cites its pinned contract, establishing the dependency boundary. Read the canonical skill, Git/context, image and result references, repository policy, and relevant helper source; commit-parent rejection, status derivation, exit handling, platform restrictions, and separate output publication support the documented claims. (skills/autoreview/scripts/autoreview:7149, 1444c91f6b45)
  • Policy, discussion and validation: Read the complete root and docs policies and applicable skills; no additional ancestor policies, maintainer notes, or pr-simplify skill were present. Discussion contains only bot status comments. Exact-head fast-validation, proof-pool contracts and CI Gate passed; runtime lanes were skipped. No helper, second reviewer, build or tests were run during this read-only review, and the checkout stayed clean. (docs/AGENTS.md:1, b8c718a56a87)
  • Feature history and inspection limits: Scoped history identifies repeated shared-review work by Vincent Koc, fallback guidance by Scott Hanselman, and the workflow guide by Barbara Kudiess. Follow-history reaches missing objects at file creation; ordinary scoped history and current-line attribution remained available. The conventional shared installation was absent, and nothing was installed. (docs/AGENT_WORKFLOWS.md:3, 489208e06780)

Likely related people:

  • Barbara Kudiess: Raw commit 3977f82 adds docs/AGENT_WORKFLOWS.md:3 relative to its recorded parents. This identifies author metadata, not feature responsibility or a PR merger. (role: source-line author; confidence: high; commits: 3977f8206ed4; files: docs/AGENT_WORKFLOWS.md)
  • Vincent Koc: Raw commit 0c6e586 adds .agents/skills/autoreview/SKILL.md:8 relative to its recorded parents. This identifies author metadata, not feature responsibility or a PR merger. (role: source-line author; confidence: high; commits: 0c6e5867e1b8; files: .agents/skills/autoreview/SKILL.md)
  • Scott Hanselman: Raw commit d6fe320 adds .agents/skills/autoreview/SKILL.md:17 relative to its recorded parents. This identifies author metadata, not feature responsibility or a PR merger. (role: source-line author; confidence: high; commits: d6fe320708a0; files: .agents/skills/autoreview/SKILL.md)

Labels

Label changes:

  • add P3: Contributor documentation improves review accuracy without changing product runtime behavior.
  • add rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🌊 off-meta tidepool 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: Contributor documentation improves review accuracy without changing product runtime behavior.
  • rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🌊 off-meta tidepool 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 October 21, 2026, 3:05 AM ET / 07:05 UTC.

@bkudiess

Copy link
Copy Markdown
Collaborator Author

Superseded by #1804 (docs: make local review scope and outcomes explicit), which publishes the same commit from a branch in openclaw/openclaw-windows-node as requested. No source changes or merge authorization are implied.

@bkudiess bkudiess closed this Oct 21, 2026
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