Code Review

Code Review

Overview

This skill provides a comprehensive code review process for the current branch. It verifies the code builds and passes tests across platforms, checks for performance regressions, and reviews the diff for bugs, improvements, and adherence to project standards.

Procedure

1. Preparation

1. Check Branch: Run git branch --show-current. If the output is main, inform the user that the current branch is main and reviews on main are not supported yet.
2. Check Remote: Run git fetch origin main. This ensures origin/main is up-to-date for accurate comparison.
3. Get Branch Point: Determine the merge base with git merge-base origin/main HEAD. Store this for later use.

2. Build & Test Verification

1. Build for All Platforms:
   • Run make build-all (covers Linux, Darwin, and Windows cross-compile, regardless of host OS).
   • Cleanup afterwards: make clean.
   • If any build fails, stop and report the error.
2. Lint & Format:
   • Run make fmt. If any files are modified, stop and report the error.
   • Run make fmt-md. If any files are modified, stop and report the error (Markdown is not formatted).
   • Run make vet. If any issues are found, stop and report the error.
3. Run All Tests:
   • Run make test to execute Go tests (unit + spec).
   • If tests fail, stop and report the errors.
4. Run WASI Tests:
   • Run make test-wasi to verify the WASI Preview 1 implementation.
   • If WASI tests fail, stop and report the errors.

3. Performance Verification

1. Compare Benchmarks: Run make bench-compare TARGET=. to compare performance against the main branch (the default base). NOTE: This can take several minutes as it runs the benchmark suite twice.
2. Review Results: Present the benchmark results to the user. Flag any regressions where:
   • Time (ns/op) increased by more than 5%.
   • Memory (B/op) increased.
   • Allocations (allocs/op) increased.

4. Dependency Check

1. Detect New Dependencies: Run git diff origin/main..HEAD -- go.mod go.sum.
2. Verify Module Consistency:
   • Run go mod tidy.
   • Run git diff --name-only go.mod go.sum.
   • If there are changes, stop and report that go mod tidy needs to be run.
3. Report Changes: If there are any changes to go.mod or go.sum:
   • CRITICAL: This project is pure Go with no CGo. New dependencies are strongly discouraged.
   • Report exactly what dependencies were added or modified.
   • Ask the user to confirm the dependency changes are intentional.

5. License Header Check

1. Find New Files: Run git diff --name-status origin/main..HEAD | grep '^A' to list all newly added files.

2. Check Headers: For each new source file (.go, .py, .yml, etc.), verify it contains the proper license header:

   // Copyright [Year] Google LLC
   //
   // Licensed under the Apache License, Version 2.0 (the "License");
   // you may not use this file except in compliance with the License.
   // You may obtain a copy of the License at
   //
   //     http://www.apache.org/licenses/LICENSE-2.0
   //
   // Unless required by applicable law or agreed to in writing, software
   // distributed under the License is distributed on an "AS IS" BASIS,
   // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   // See the License for the specific language governing permissions and
   // limitations under the License.

   Use the appropriate comment syntax for the file type (e.g., # for Python and YAML).

3. Report Missing Headers: List any files missing the license header.