sdk-review

name	sdk-review
description	Use when local changes need convention compliance checking before committing or raising a PR. Also use after receiving PR review comments to fix them locally. Triggers on "review my changes", "fix review comments", "run code review", "sdk-review", "check conventions".

SDK Review

Review and fix local changes (committed + staged + unstaged vs main) against project conventions in a loop until clean.

Core principle: The review agent reads CLAUDE.md/agent_docs — don't re-teach conventions here. This skill's value is the loop mechanics, prioritization rules, and expert knowledge about what review agents get wrong.

---

Detect Changes

git diff --name-only main...HEAD   # committed
git diff --name-only --cached       # staged
git diff --name-only                # unstaged

Merge into one deduplicated set. If empty, report "Nothing to review" and stop.

---

Review-Fix Loop (max 3 iterations)

digraph review_loop {
    "Run review agent" [shape=box];
    "Issues found?" [shape=diamond];
    "Fix critical + important" [shape=box];
    "typecheck + lint + test pass?" [shape=diamond];
    "Fix build errors" [shape=box];
    "iteration < 3?" [shape=diamond];
    "Fixes made in any iteration?" [shape=diamond];
    "Commit fixes" [shape=box];
    "Report" [shape=doublecircle];

    "Run review agent" -> "Issues found?";
    "Issues found?" -> "Fixes made in any iteration?" [label="no — clean"];
    "Issues found?" -> "Fix critical + important" [label="yes"];
    "Fix critical + important" -> "typecheck + lint + test pass?";
    "typecheck + lint + test pass?" -> "iteration < 3?" [label="yes"];
    "typecheck + lint + test pass?" -> "Fix build errors" [label="no"];
    "Fix build errors" -> "iteration < 3?";
    "iteration < 3?" -> "Run review agent" [label="yes"];
    "iteration < 3?" -> "Commit fixes" [label="no — max reached"];
    "Fixes made in any iteration?" -> "Commit fixes" [label="yes"];
    "Fixes made in any iteration?" -> "Report" [label="no — nothing to commit"];
    "Commit fixes" -> "Report";
}

---

Step 1: Review

Launch an agent that reads CLAUDE.md (which loads Agents.md and agent_docs/ via @ references), gets the full diff (git diff main...HEAD + git diff --cached + git diff), and returns a structured report classifying issues as Critical, Important, or Suggestion with file:line, violated rule, and recommended fix.

Review scope: diff lines only. Read full files for context (imports, class structure, surrounding code) but ONLY flag issues on lines that appear in the diff. Pre-existing issues on unchanged lines are out of scope — even if they violate conventions.

Scope the diff correctly. If local main is stale, main...HEAD pulls in unrelated already-merged PRs. Prefer origin/main...HEAD (after git fetch) so the review covers only this branch's changes.

Review agent calibration — what agents get wrong in this codebase

The conventions in agent_docs are comprehensive, but review agents consistently misjudge these areas:

Over-reported (false positives to ignore):

• JSDoc style preferences on existing methods not touched in the diff
• Suggesting interface extends when type intersection is the correct pattern per conventions.md
• Flagging param || {} on genuinely optional parameters (only flag on required params)
• Reporting missing tests for private helper methods — only public methods need tests
• Flagging field map entries that look like "case-only" renames but are actually semantic renames

Under-reported (agents miss these — explicitly check):

• @track decorator missing on new public methods — agents skip this 50% of the time
• JSDoc on ServiceModel not synced with service class implementation
• export type * from in barrel files instead of export * from (drops runtime values silently)
• Mock factories typed as {Entity}GetResponse instead of Raw{Entity}GetResponse
• Missing docs/oauth-scopes.md entry for new methods

Ambiguous (ask user, don't auto-fix):

• Whether a new method should have bound methods (depends on entity lifecycle)
• Endpoint grouping structure for new API domains
• Whether a field is optional or required in the response type (needs live API check)

Sample apps (samples/) are not the SDK library — the agent_docs conventions (@track, ServiceModel JSDoc, barrel exports, transform pipeline, pagination) do NOT apply. When the diff is under samples/, review only for: dead code left by a migration (unused env vars, orphaned vite-env.d.ts type decls, stale .env), any types, correctness of the change, favicon/config consistency with the golden sample, and secrets — uipath.json.example must hold placeholders (<your-...>), never real client IDs/orgs, and .gitignore must ignore .uipath. Hold sample code to a "clear, correct example" bar, not SDK-library rigor.

---

Step 2: Fix

Fix in priority order: Critical first, then Important.

NEVER fix:

• Suggestions — report to user, may involve design decisions
• Files not in the diff — pre-existing issues are out of scope
• Public API type signatures — changing return types or parameter types can break consumers; report instead
• Test assertions — changing what tests assert can mask real failures; report instead

After fixing, run npm run typecheck, npm run lint, and npm run test:unit. If any fail, fix the error before the next review iteration. If an error persists after 2 attempts, stop and report it — don't loop on the same failure.

---

Step 3: Commit

Only reached when fixes were made. Stage and commit:

git add <fixed files>
git commit -m "fix: address convention review comments"

Do NOT push. The user or calling skill (sdk-ship) decides when to push.

---

Step 4: Report

## SDK Review Summary

**Iterations:** X/3
**Status:** Clean | X issues remaining

### Fixed (Y items)
- [file:line] Brief description

### Remaining (if any)
- [file:line] Brief description — why not auto-fixed

### Suggestions (not auto-fixed)
- [file:line] Brief description — user decision needed

---

NEVER

• NEVER review files not in the diff — pre-existing issues are not this skill's job
• NEVER fix and re-review in the same iteration — fix first, THEN re-run the review agent fresh
• NEVER auto-fix the same issue differently across iterations — if iteration 1 fixed X one way and iteration 2 flags X again, stop and report; don't oscillate
• NEVER suppress typecheck/lint/test failures — if a fix breaks the build or tests, the fix is wrong
• NEVER commit if no files were modified — if review is clean and no fixes were made in any iteration, skip commit entirely
• NEVER continue past 3 iterations — if issues remain, report them; infinite loops waste tokens and patience