スキル一覧に戻る
onepunch-tk

review-report

by onepunch-tk

0🍴 0📅 2026年1月25日
GitHubで見るManusで実行

SKILL.md


name: review-report description: "A universal report skill for saving code review and security review results as Markdown files with checklist-based progress tracking. Differentiates review types by directory (docs/reports/code-review/, docs/reports/security-review/). Generates Markdown files via automatic script invocation. Used by code-reviewer and security-reviewer agents after review completion." allowed-tools:

  • Read
  • Glob
  • Grep
  • Bash

Review Report

A universal skill for saving review results as structured Markdown files with fix checklists for progress tracking.

Core Features

  1. Markdown format report generation: Saves structured issue lists with visual formatting
  2. Directory-based classification: Automatic classification by review type
  3. Automatic script invocation: Uses Python script for token efficiency
  4. Fix checklist generation: Enables progress tracking for issue resolution

Report Generation Procedure

Follow these steps to generate a report using this skill:

Step 1: Organize Issue Data

Organize discovered issues as a JSON array:

[
  {
    "file": "app/components/example.tsx",
    "location": "23:5",
    "severity": "high",
    "category": "type-safety",
    "problem": "Type safety violation due to any type usage",
    "suggestion": "Change to unknown type and apply Type Guard",
    "rationale": "TypeScript strict mode requires explicit typing to prevent runtime errors",
    "evidence": "Code: `const data: any = response;` violates project TypeScript rules (CLAUDE.md Section 4)",
    "references": []
  }
]

Step 2: Execute Script

Execute the following command using the Bash tool:

python .claude/skills/review-report/scripts/generate_report.py \
  --output <directory> \
  --issues '<JSON array>'

Output directories:

  • Code review: docs/reports/code-review
  • Security review: docs/reports/security-review

Example (code review):

python .claude/skills/review-report/scripts/generate_report.py \
  --output docs/reports/code-review \
  --issues '[{"file":"app/components/Button.tsx","location":"15:3","severity":"high","category":"type-safety","problem":"any type usage","suggestion":"Use unknown instead"}]'

If no issues found:

python .claude/skills/review-report/scripts/generate_report.py \
  --output docs/reports/code-review \
  --issues '[]'

Step 3: Verify Results

After execution, confirm the "리포트 생성 완료" message and file path.

Additionally, verify file creation:

ls -la docs/reports/code-review/*.md | tail -1

Step 4: Track Fixes via Checklist

⚠️ MANDATORY: After fixing issues, agents MUST update the report checkboxes.

The generated Markdown report includes a Fix Checklist section:

## ✅ Fix Checklist

**⚠️ MANDATORY**: Check each box (`- [x]`) immediately after fixing the issue.

Track your progress by checking off fixed issues:

- [ ] #1 [Critical] path/to/file.ts:23 - Brief problem description

Checklist Update Protocol:

  1. Fix the issue in source code
  2. Open the generated .md report file using Read tool
  3. Change checkbox: - [ ]- [x] for the fixed issue
  4. Save changes using Edit tool
  5. Track overall progress by reviewing completed items
  6. When all items are checked, update report status to ✅ Complete

CRITICAL: Checkboxes MUST be checked immediately after each fix. Do NOT batch checkbox updates.


Issue Field Description

FieldRequiredDescription
fileOFile path
locationOLine:column (e.g., "23:5")
severityOcritical / high / medium / low
categoryOIssue classification (type-safety, convention, security, etc.)
problemODetailed problem description
suggestionOFix suggestion
rationaleOReasoning basis for why this is an issue (reference to rules, best practices, documentation)
evidenceOConcrete proof supporting the finding (code snippet, compiler error, documentation quote, context7 reference)
referencesOArray of referenced document paths (use empty array [] if none)

Severity Criteria

  • critical: Runtime errors, security vulnerabilities (immediate fix required)
  • high: Type safety, major convention violations
  • medium: Code quality, performance improvement recommendations
  • low: Style, documentation recommendations

Categories by Review Type

Code Review (docs/reports/code-review/)

  • type-safety: Type safety (any usage, missing generic constraints, etc.)
  • convention: Code conventions (function declaration style, naming, etc.)
  • react19: React 19 optimization rules (unnecessary memoization, etc.)
  • deprecated-api: Deprecated APIs
  • code-quality: Code quality (duplication, complexity, etc.)

Security Review (docs/reports/security-review/)

  • injection: Injection vulnerabilities (SQL, XSS, Command, etc.)
  • access-control: Access control issues
  • auth-failure: Authentication/session management issues
  • crypto-failure: Cryptography-related issues
  • security-misconfig: Security configuration errors

Filename Convention

{8-char_random_hash}_{YYYYMMDD}.md

Example: a1b2c3d4_20260119.md


Generated Report Structure

The generated Markdown report includes:

  1. Header: Review type, status, generation timestamp, total issues
  2. Summary Table: Issue count by severity with visual indicators
  3. Issues Section: Organized by severity (Critical → Low) with detailed tables
  4. Fix Checklist: Checkbox items for tracking progress
  5. Notes Section: Additional context and recommendations

Example output:

# Code Review Report

**Status**: 🔄 In Progress
**Generated**: 2026-01-22 10:30:00 (UTC)
**Total Issues**: 5

---

## 📊 Summary

| Severity | Count |
|----------|-------|
| 🔴 Critical | 1 |
| 🟠 High | 2 |
| 🟡 Medium | 1 |
| 🟢 Low | 1 |

---

## 🔍 Issues

### 🔴 Critical Issues

| # | File | Location | Category | Problem | Suggestion |
|---|------|----------|----------|---------|------------|
| 1 | ... | ... | ... | ... | ... |

---

## ✅ Fix Checklist

- [ ] #1 [Critical] file.ts:10 - Problem description
- [ ] #2 [High] file.ts:20 - Problem description
...

JSON Escape Notes

  • Single quotes (') inside JSON should be escaped as '\''
  • Double quotes (") are JSON standard, use as-is
  • Korean characters can be used directly

References

  • Markdown template details: references/report-template.md
  • Security review reference: .claude/skills/owasp-top10-2025/references/

スコア

総合スコア

50/100

リポジトリの品質指標に基づく評価

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

レビュー

💬

レビュー機能は近日公開予定です