Skip to main content

code-review-checklist

Code review guidelines covering code quality, security, and best practices.

소스 정보

저장소
HaoNgo232/agent-bridge-kit
최근 소스 활동
2026년 5월 21일 01:46
감지된 SKILL.md 언어
영어
스타
3
포크
0

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
name
code-review-checklist
description
Code review guidelines covering code quality, security, and best practices.
when_to_use
When reviewing code for quality, security, and best practices. When the user says 'review my code' or 'check this PR'.
allowed-tools
Read, Glob, Grep
# Code Review Checklist ## Quick Review Checklist ### Correctness - [ ] Code does what it's supposed to do - [ ] Edge cases handled - [ ] Error handling in place - [ ] No obvious bugs ### Security - [ ] Input validated and sanitized - [ ] No SQL/NoSQL injection vulnerabilities - [ ] No XSS or CSRF vulnerabilities - [ ] No hardcoded secrets or sensitive credentials - [ ] **AI-Specific:** Protection against Prompt Injection (if applicable) - [ ] **AI-Specific:** Outputs are sanitized before being used in critical sinks ### Performance - [ ] No N+1 queries - [ ] No unnecessary loops - [ ] Appropriate caching - [ ] Bundle size impact considered ### Code Quality - [ ] Clear naming - [ ] DRY - no duplicate code - [ ] SOLID principles followed - [ ] Appropriate abstraction level ### Testing - [ ] Unit tests for new code - [ ] Edge cases tested - [ ] Tests readable and maintainable ### Documentation - [ ] Complex logic commented - [ ] Public APIs documented - [ ] README updated if needed ## AI & LLM Review Patterns (2025) ### Logic & Hallucinations - [ ] **Chain of Thought:** Does the logic follow a verifiable path? - [ ] **Edge Cases:** Did the AI account for empty states, timeouts, and partial failures? - [ ] **External State:** Is the code making safe assumptions about file systems or networks? ### Prompt Engineering Review ```markdown // ❌ Vague prompt in code const response = await ai.generate(userInput); // ✅ Structured & Safe prompt const response = await ai.generate({ system: "You are a specialized parser...", input: sanitize(userInput), schema: ResponseSchema }); ``` ## Anti-Patterns to Flag ```typescript // ❌ Magic numbers if (status === 3) { ... } // ✅ Named constants if (status === Status.ACTIVE) { ... } // ❌ Deep nesting if (a) { if (b) { if (c) { ... } } } // ✅ Early returns if (!a) return; if (!b) return; if (!c) return; // do work // ❌ Long functions (100+ lines) // ✅ Small, focused functions // ❌ any type const data: any = ... // ✅ Proper types const data: UserData = ... ``` ## Review Comments Guide ``` // Blocking issues use 🔴 🔴 BLOCKING: SQL injection vulnerability here // Important suggestions use 🟡 🟡 SUGGESTION: Consider using useMemo for performance // Minor nits use 🟢 🟢 NIT: Prefer const over let for immutable variable // Questions use ❓ ❓ QUESTION: What happens if user is null here? ```
GitHub에서 보기