AgentSkillsCN

code-review-guideline

针对通用开发及 Rails 项目制定代码评审指南。涵盖评审者心态、不同视角的评审方法、Rails 特定规则，以及测试质量标准。适用于代码评审、Pull Request 审核、代码审查，助力提升代码质量。

SKILL.md
--- frontmatter
name: code-review-guideline
description: Code review guidelines for general development and Rails projects. Provides reviewer personality, review perspectives, Rails-specific rules, and test quality standards. Use for code review, PR review, review code, check code quality.
user-invocable: false
context: fork
agent: General-purpose
allowed-tools:
  - Read
  - Glob
  - Grep

Code Review Guideline Skill

This skill provides comprehensive code review guidelines for the code-reviewer SubAgent.

Overview

This skill contains detailed code review guidelines including:

  • •Reviewer personality and communication style
  • •General code review perspectives
  • •Rails-specific review guidelines
  • •Test quality standards

Documents

DocumentDescription
docs/000_REVIEWER_PERSONALITY.mdReviewer personality, mindset, and communication style
docs/001_GENERAL_CODE_REVIEW_GUIDELINE.mdGeneral code review perspectives and principles
docs/002_RAILS_CODE_REVIEW_GUIDELINE.mdRuby on Rails specific review guidelines
docs/003_TEST_GUIDELINE.mdTest quality standards and coverage requirements

Usage

When conducting code reviews, refer to these documents for:

  1. •Reviewer Mindset: Start with 000_REVIEWER_PERSONALITY.md to understand the expected reviewer attitude
  2. •General Quality: Apply principles from 001_GENERAL_CODE_REVIEW_GUIDELINE.md
  3. •Rails Patterns: Use 002_RAILS_CODE_REVIEW_GUIDELINE.md for Rails-specific checks
  4. •Test Quality: Ensure tests meet standards in 003_TEST_GUIDELINE.md

Key Review Perspectives

Labeling Convention

  • •[must]: Must fix - critical issues
  • •[ask]: Need clarification - intent unclear
  • •[imo]: Personal opinion - subjective suggestion
  • •[nits]: Minor point - nitpicks
  • •[suggestion]: Alternative approach

Priority Areas

  1. •Security vulnerabilities
  2. •Data integrity issues
  3. •Performance problems (N+1, memory)
  4. •Code design and maintainability
  5. •Test coverage and quality