搜索

PythonReactSEOPDF
GitHub Skill

code-review

Self-review code changes before commit to ensure quality

rom-orlovich☆ 0 仓库 Stars0 仓库 Forks

安装与使用

请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。

查看来源 ↗使用指南

技能说明

Code Review Skill

This skill performs automated self-review of code changes before committing to ensure code quality and catch potential issues.

Purpose

Ensure code changes meet quality standards before commit by performing automated checks and analysis.

When to Use

  • Before final commit of any code changes
  • After implementing fixes (GREEN phase of TDD)
  • When preparing PR for human review

Checks Performed

1. Code Style & Patterns
  • Code follows project-specific patterns and conventions
  • Consistent naming conventions (camelCase, snake_case, etc.)
  • Proper import organization
  • No unused imports or variables
2. Static Analysis
  • No linting errors (eslint, flake8, biome, etc.)
  • No type errors (mypy, tsc, etc.)
  • No security vulnerabilities (basic patterns)
3. Test Coverage
  • All modified code has corresponding tests
  • New functionality includes test cases
  • Edge cases are considered
4. Code Quality
  • No hardcoded secrets or sensitive data
  • Proper error handling
  • No console.log/print statements in production code
  • Functions are reasonably sized
5. Documentation
  • Public functions have docstrings/comments
  • Complex logic is documented
  • README updated if needed

Process

  1. Identify Changed Files

    • Compare against the base branch
    • List all modified, added, deleted files
  2. Run Project Linters

    • Execute project-specific lint commands
    • Report any errors or warnings
  3. Type Check (if applicable)

    • Run TypeScript/mypy/other type checkers
    • Report type errors
  4. Security Scan

    • Check for hardcoded secrets
    • Check for common security anti-patterns
  5. Generate Report

    • List all issues found
    • Categorize by severity (error, warning, info)

Output Format

{
  "status": "pass|fail",
  "files_reviewed": 5,
  "issues": [
    {
      "file": "src/auth.ts",
      "line": 45,
      "severity": "error",
      "category": "linting",
      "message": "Missing semicolon"
    }
  ],
  "summary": {
    "errors": 0,
    "warnings": 2,
    "info": 1
  },
  "recommendation": "Ready to commit" | "Fix errors before committing"
}

Important

  • NEVER skip this review step
  • If any errors are found, they MUST be fixed before commit
  • Warnings should be addressed if time permits
  • If review cannot be completed, report the blocker

使用示例

查看来源仓库中的使用示例与配置说明。

查看来源 ↗

来源历史

收录时间
2026-01-20
索引更新时间
2026-01-26
Branch
main

收录与同步日期属于本站记录。源码修改历史请查看来源仓库。

GitHub ↗

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!