Reviewing Source Code Changes

Guide for reviewing PRs and source code changes in packages/ and frameworks/.

When to Use This Guide

• Reviewing pull requests modifying library source
• Validating implementation patterns before merging
• Checking code quality, types, documentation, and tests

Review Process

1. Understand the change — Read PR description, identify affected files
2. Check patterns — Verify code follows existing conventions
3. Verify types — Ensure type safety and proper inference
4. Review docs — Confirm JSDoc is complete and accurate
5. Check tests — Validate runtime and type test coverage

What to Review

Code Quality

Good — purity annotation:

// @__NO_SIDE_EFFECTS__
export function useField<TSchema, TFieldPath>(
  form: FormStore<TSchema>,
  config: UseFieldConfig<TSchema, TFieldPath>
): FieldStore<TSchema, TFieldPath> {
  return {
    /* ... */
  };
}

Bad — missing annotation:

export function useField<TSchema, TFieldPath>(
  form: FormStore<TSchema>,
  config: UseFieldConfig<TSchema, TFieldPath>
): FieldStore<TSchema, TFieldPath> {
  return {
    /* ... */
  };
}

Type Safety

Good — constrained generic:

export function useField<
  TSchema extends Schema,
  TFieldPath extends RequiredPath<TSchema>,
>(
  form: FormStore<TSchema>,
  config: UseFieldConfig<TSchema, TFieldPath>
): FieldStore<TSchema, TFieldPath>;

Documentation

First line patterns by category:

Tests

Common Issues

Checklist

• Implementation follows existing patterns in similar files
• // @__NO_SIDE_EFFECTS__ on pure factory functions
• All imports use .ts extension
• interface used for object shapes
• JSDoc complete on all exports
• Runtime tests in .test.ts
• Type tests in .test-d.ts
• Naming conventions followed
• Cross-framework consistency for shared APIs

Related Skills

• repo-structure-navigate — Navigate the codebase
• repo-source-code-document — JSDoc requirements