跳到正文
cccskills
免费在 GitHub 公开

code-review

Comprehensive code review for commits and pull requests. Covers security, TDD, code quality, and documentation standards.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(7)

  • SKILL.md6.8 KB
  • references/iso27001-guidelines.md14.6 KB
  • references/review-templates.md5.3 KB
  • references/security-patterns.md8.5 KB
  • references/tdd-patterns.md10.5 KB
  • references/validation-false-positives.md9.5 KB
  • SKILL.extended.md14.2 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Code Review Skill

Review in this order, stopping only to record findings:

Code Changes -> Security Scan (P1) -> TDD Validation (P2) -> Code Quality -> Verdict

Deep examples live in references/. Do not re-derive them here:

  • references/security-patterns.md - per-language vulnerable/safe pairs
  • references/tdd-patterns.md - TDD process + test quality examples
  • references/review-templates.md - copy-paste review templates
  • references/iso27001-guidelines.md - compliance checklist
  • references/validation-false-positives.md - anti-patterns when reviewing validation/audit code

Security Checklist (Critical)

OWASP Top 10

VulnerabilityRed Flag
InjectionString concatenation in queries
Broken AuthPlain text passwords, weak tokens
Sensitive Data ExposureSecrets in logs
XSSinnerHTML, dangerouslySetInnerHTML
Broken Access ControlMissing permission checks

Security Code Patterns

RiskBADGOOD
SQL Injectionconst query = `SELECT * FROM users WHERE id = ${userId}`;const query = 'SELECT * FROM users WHERE id = ?'; db.query(query, [userId]);
XSSelement.innerHTML = userInput;element.textContent = userInput;
Command injectionexec(`ls ${userPath}`);fs.readdir(userPath);
Hardcoded secretsconst apiKey = 'sk-1234567890';const apiKey = process.env.API_KEY;

Security Review Questions

  • ALL user input validated/sanitized?
  • Queries parameterized?
  • Secrets in environment variables?
  • Auth checked on protected routes?
  • Error messages safe (no stack traces)?

TDD Checklist (Priority)

QuestionExpectedRed Flag
Tests written first?YesImplementation without tests
Tests define behavior?WHAT not HOWInternal implementation tested
Coverage adequate?Critical paths coveredOnly happy path
Tests independent?Run in isolationOrder-dependent

Test Quality Patterns

RuleBADGOOD
Test behavior, not internalsjest.spyOn(service, '_privateMethod') then expect(spy).toHaveBeenCalled() (HOW)const result = service.doThing(); expect(result).toEqual(expectedOutput); (WHAT)
Realistic test dataconst mockUser = { id: 1, name: 'test' };const mockUser = { id: 'usr_abc123', name: 'Jane Smith', email: 'jane@example.com', createdAt: new Date('2024-01-15'), roles: ['user', 'admin'] };
Cover edge cases, not just happy pathonly test('creates user', ...)plus throws on missing email, throws on duplicate username, handles unicode names

Code Quality Checklists

No Shortcuts

PatternProblem
catch (e) { }Silent exception
TODO, FIXME, HACKIncomplete work
Commented-out codeDead code
any overuseType safety bypassed

No Hardcoded Values

BadGood
if (status === 3)if (status === Status.APPROVED)
setTimeout(fn, 5000)setTimeout(fn, TIMEOUT_MS)
'http://localhost:3000'process.env.API_URL

Root Cause Fixes

Symptom Fix (Bad)Root Cause Fix (Good)
Add null check where crash occursValidate data at entry point
Retry failed request 3 timesFix why request fails
Catch and ignore errorHandle error appropriately
Add delay to avoid race conditionFix the race condition

Documentation (Mandatory)

LevelRequired
File@file, @description, @related
ClassPurpose, responsibilities
Function@param, @returns, @throws
// BAD: No documentation
export function createUser(data) {
  return db.create(data);
}

// GOOD: Full documentation
/**
 * Creates a new user account with validation.
 *
 * @param data - User creation input
 * @returns Created user object
 * @throws {ValidationError} If email invalid
 *
 * @related
 *   - ./UserRepository.ts - Database persistence
 *   - ../validators/email.ts - Email validation
 */
export async function createUser(data: CreateUserInput): Promise<User>

Red Flags

FlagSeverityAction
SQL/Command injectionCRITICALBlock
Hardcoded secretsCRITICALBlock
XSS vulnerabilityCRITICALBlock
No tests for new codeMAJORRequest tests
Tests modified to passMAJORInvestigate
Silent exception catchMAJORRequire logging
Missing file headerMAJORAdd docs

Output Format

# Code Review: [Branch/PR]

## Summary
| Metric | Value |
|--------|-------|
| Files reviewed | X |
| Security issues | X (Y critical) |
| TDD compliance | Y/N |
| Verdict | Ready/Review/Rework |

## Security Issues
### Critical
1. **[Type]** - `file:line`
   - Problem: [desc]
   - Impact: [potential damage]
   - Fix: [solution]

## TDD Issues
1. **[Issue]** - `file:line`
   - Fix: [tests to add]

## Code Quality Issues
[issues]

## Verdict
[decision + reasoning]

### Required Before Merge
- [ ] [action item]

Review Workflow

Step 1: Security Scan First

# Check for secrets
grep -r "password\|secret\|api_key\|token" --include="*.ts"

# Check for SQL injection
grep -r "SELECT.*\${" --include="*.ts"

# Check for XSS
grep -r "innerHTML\|dangerouslySetInnerHTML" --include="*.tsx"

Step 2: TDD Validation

# Check test coverage
npm test -- --coverage

# Verify tests exist for changed files

Verdict Rules

ConditionVerdict
Any critical securityNeeds Rework
No tests for new functionalityNeeds Review
Minor issues onlyReady (with suggestions)
No issuesReady to merge

Example: Transparency Block

<decision-transparency>
**Decision:** Approve with minor suggestions (Ready)

**Reasoning:**
- **Security**: No vulnerabilities found
- **Testing**: All new code has tests
- **Quality**: Minor naming suggestions only

**Issues Found:**
1. Minor: Variable name `d` could be `data` (line 42)
2. Minor: Consider extracting magic number 5 to constant

**Confidence:** High - Standard approval scenario
</decision-transparency>

Example: Debate Invitation

<debate-invitation>
**Topic:** Handling of deprecated API usage

**Option A: Block Until Fixed**
- Pros: No technical debt
- Cons: Delays release

**Option B: Approve with Follow-up Task**
- Pros: Pragmatic, allows progress
- Cons: Debt may linger

**My Lean:** Option B - Create ticket, set deadline

**Your Input Needed:** Is there a release deadline? How critical is this code path?
</debate-invitation>

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

AID Phase 4 - Development phase. Use for implementing features, TDD practices, code reviews, transitioning from planning to QA.

中文简介正在准备中。当前显示原文说明。

ilandahan/AID102026年9月23日 更新

AID Phase 0 - Research & discovery. Use for validating problem spaces, identifying stakeholders, defining success metrics, deciding whether to proceed.

中文简介正在准备中。当前显示原文说明。

ilandahan/AID102026年9月23日 更新

AID Phase 3 - Implementation Planning with consolidation-first approach. Resolves contradictions between PRD and Tech Spec, creates consolidated master document, then breaks down into actionable tasks and populates Jira. Includes sprint planning and risk assessment.

中文简介正在准备中。当前显示原文说明。

ilandahan/AID102026年9月23日 更新

aid-prd

免费

AID Phase 1 - PRD creation. Use for user stories, acceptance criteria, scoping features, transitioning from discovery to tech spec.

中文简介正在准备中。当前显示原文说明。

ilandahan/AID102026年9月23日 更新

AID Phase 5 - QA and Release. Use for validating implementations, acceptance tests, preparing releases, deployment, operational readiness.

中文简介正在准备中。当前显示原文说明。

ilandahan/AID102026年9月23日 更新

AID Phase 2 - Technical Specification. Use for system architecture, API contracts, data models, security architecture, transitioning from PRD to implementation.

中文简介正在准备中。当前显示原文说明。

ilandahan/AID102026年9月23日 更新

查看 ilandahan 的全部技能

报告此技能的问题