Skip to content

build: Import most of graham-code-review - #191

Merged
grahamking merged 2 commits into
mainfrom
gk-review-skill
Jul 29, 2026
Merged

build: Import most of graham-code-review#191
grahamking merged 2 commits into
mainfrom
gk-review-skill

Conversation

@grahamking

@grahamking grahamking commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Merge in to switchyard-rust-review skill.

Thanks Ayush!

Summary by CodeRabbit

  • Documentation
    • Expanded the Rust review guidance with a structured, multi-pass workflow.
    • Added detailed checks for error handling, logging, concurrency, async behavior, allocations, FFI, streaming, and interface boundaries.
    • Added guidance on comments, naming, test selection, and final review verification.
    • Documented validation commands and reporting expectations for formatting, linting, and tests.

Merge in to `switchyard-rust-review` skill.

Thanks Ayush!

Signed-off-by: Graham King <grahamk@nvidia.com>
@grahamking
grahamking requested a review from a team as a code owner July 29, 2026 21:15
@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The switchyard-rust-review skill was replaced with a structured Rust review philosophy, workflow, detailed correctness rubric, second-pass checklist, and concrete validation commands.

Changes

Rust Review Skill

Layer / File(s) Summary
Review philosophy and workflow
.agents/skills/switchyard-rust-review/SKILL.md
Adds license metadata, core review principles, required tone, and a step-by-step multi-pass review workflow.
Detailed checks and validation
.agents/skills/switchyard-rust-review/SKILL.md
Adds granular Rust, async, logging, naming, testing, second-pass, and cargo validation guidance.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

A rabbit reviews with a hop and a cheer,
New Rust rules make every pathway clear.
Tracing fields sparkle, locks rest tight,
Second passes catch bugs in flight.
Cargo commands thump through the night.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: importing most of graham-code-review into the switchyard-rust-review skill.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.agents/skills/switchyard-rust-review/SKILL.md (1)

101-110: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Keep the workspace test gate mandatory.

The repository’s testing guidance defines cargo test --workspace as the Rust workspace gate, but this section makes it conditional and defaults to cargo test -p <affected-crate>. Keep the package test as an optional fast check, then require the workspace test for review validation.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/switchyard-rust-review/SKILL.md around lines 101 - 110,
Update the testing commands in the review validation guidance so cargo test
--workspace is mandatory for Rust changes, while cargo test -p <affected-crate>
remains an optional narrow fast check. Preserve the existing formatting, clippy,
Python-test, and reporting guidance, and retain the workspace test requirement
for shared or cross-crate changes.
🧹 Nitpick comments (1)
.agents/skills/switchyard-rust-review/SKILL.md (1)

53-55: 🩺 Stability & Availability | 🔵 Trivial | ⚡ Quick win

Scope parking_lot::RwLock to synchronous code. In async paths, a contended parking_lot lock blocks the executor thread; keep tokio::sync::RwLock there and use parking_lot only for synchronous critical sections.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/switchyard-rust-review/SKILL.md around lines 53 - 55, Revise
the locking guidance in the Rust review skill to scope parking_lot::RwLock to
synchronous critical sections only. Explicitly retain tokio::sync::RwLock for
async paths where contention could block the executor, while preserving the
existing no-.await-across-lock condition for synchronous usage.

Source: MCP tools

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.agents/skills/switchyard-rust-review/SKILL.md:
- Around line 38-40: Update the review-target identification step in SKILL.md to
inspect the PR diff rather than relying on bare git diff; use the
platform-provided diff or an explicit base-to-HEAD comparison such as
<base>...HEAD so committed PR changes are included, while retaining git status
and diff-stat context as appropriate.

---

Outside diff comments:
In @.agents/skills/switchyard-rust-review/SKILL.md:
- Around line 101-110: Update the testing commands in the review validation
guidance so cargo test --workspace is mandatory for Rust changes, while cargo
test -p <affected-crate> remains an optional narrow fast check. Preserve the
existing formatting, clippy, Python-test, and reporting guidance, and retain the
workspace test requirement for shared or cross-crate changes.

---

Nitpick comments:
In @.agents/skills/switchyard-rust-review/SKILL.md:
- Around line 53-55: Revise the locking guidance in the Rust review skill to
scope parking_lot::RwLock to synchronous critical sections only. Explicitly
retain tokio::sync::RwLock for async paths where contention could block the
executor, while preserving the existing no-.await-across-lock condition for
synchronous usage.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: ae3525d3-6f66-4821-b452-f665185f2315

📥 Commits

Reviewing files that changed from the base of the PR and between c8ca731 and ac5abe4.

📒 Files selected for processing (1)
  • .agents/skills/switchyard-rust-review/SKILL.md

Comment thread .agents/skills/switchyard-rust-review/SKILL.md Outdated
Remove the `git` specific instructions. Agents know how to use it.

Add rule to use `parking_lot::Mutex`.

Signed-off-by: Graham King <grahamk@nvidia.com>
@grahamking
grahamking merged commit 96a5516 into main Jul 29, 2026
12 checks passed
@grahamking
grahamking deleted the gk-review-skill branch July 29, 2026 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants