code-review

Reviews git diff changes for TypeScript performance, bundle size, and API ergonomics.

82|12|Updated Mar 31, 2023
One-click install
npx skills add https://github.com/streaming-video-technology-alliance/common-media-library --skill code-review-streaming-video-technology-alliance
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-review
Source: https://github.com/streaming-video-technology-alliance/common-media-library/tree/main/.claude/skills/code-review
Command: npx skills add https://github.com/streaming-video-technology-alliance/common-media-library --skill code-review-streaming-video-technology-alliance

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the need for thorough code quality assurance by identifying potential issues before they are merged, ensuring higher standards for performance, maintainability, and adherence to best practices.

Core Features & Use Cases

  • Performance Analysis: Detects performance bottlenecks and suggests optimizations.
  • Bundle Size Optimization: Reviews code for tree-shaking compatibility and potential bloat.
  • API Ergonomics: Assesses the usability and intuitiveness of the code's API design.
  • TypeScript Best Practices: Enforces modern TypeScript conventions and type safety.
  • Project Conventions: Ensures adherence to established project coding standards.
  • Use Case: A developer submits a pull request. The code-review skill analyzes the changes, providing feedback on potential performance regressions, API clarity, and adherence to TypeScript standards, helping the team maintain a high-quality codebase.

Quick Start

Use the code-review skill to review all pending changes in the current branch.

Frequently Asked Questions about code-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review code changes for TypeScript best practices and API ergonomics?

To review code changes for TypeScript best practices and API ergonomics, analyze your git diff of staged and unstaged changes to identify performance bottlenecks, verify tree-shaking compatibility, and enforce type safety conventions.

What is the best way to detect performance bottlenecks and bundle size bloat in a pull request?

The best way to detect performance bottlenecks and bundle size bloat in a pull request is to analyze git diffs for tree-shaking compatibility and potential code bloat, ensuring higher standards for performance before merging.

Can I use a code review skill to ensure adherence to project conventions across unstaged git changes?

Yes, you can review unstaged git changes to ensure adherence to project conventions by analyzing the git diff for API ergonomics, bundle size optimization, and modern TypeScript conventions.

Does code review for git diffs require any specific dependencies or environment setup?

Code review for git diffs requires no specific dependencies or environment setup. It directly processes staged and unstaged changes from your current branch to provide feedback on performance and API design.

Why does my TypeScript code review fail to catch bundle size optimization issues?

Your TypeScript code review may fail to catch bundle size optimization issues if it does not specifically analyze the git diff for tree-shaking compatibility, which is required to detect potential code bloat before merging.

When do I need to run a code review on my current software development branch?

You need to run a code review on your software development branch before merging a pull request to identify potential performance regressions, verify API clarity, and ensure adherence to TypeScript standards.