Chapter 56 · Reviewing Claude Config
Subchapter 56.7
checklists/prompts.mdMarkdown5 KBView on GitHub
Review checklist for changes to .claude/prompts/*.md and .claude/commands/*.md files.
Clear Purpose Statement: Every prompt/command file should answer these questions in first 1-3 lines:
# Command Name
Brief description of what this does and when to use it.Examples:
✅ GOOD - Clear purpose:
# review-pr
Reviews a GitHub pull request by number. Use when analyzing PR changes before merge.
Usage: /review-pr <pr-number>❌ BAD - Vague purpose:
# review-pr
Does PR stuff.Complete Prompt Elements:
Self-Contained vs Skill Reference:
✅ GOOD - Simple task, self-contained:
# format-commit
Generate a conventional commit message from staged changes.
Format: `type(scope): description`
Types: feat, fix, docs, style, refactor, test, chore✅ GOOD - Complex task, reference skill:
# review-changes
Review current git changes for code quality and architectural compliance.
Use the `reviewing-changes` skill to perform comprehensive review based on change type.❌ BAD - Complex task without guidance:
# review-changes
Review the code.Clarity and Specificity:
❌ VAGUE: “Look at the files and find problems” ✅ SPECIFIC: “Analyze modified Kotlin files for MVVM violations: mutable state exposure, improper dependency injection, missing error handling”
Logical Structure:
✅ GOOD - Step-by-step:
1. Read the PR description and changed files
2. Identify the change type (feature, bug fix, refactor)
3. Apply appropriate review checklist
4. Document findings with inline commentsExamples for Complex Tasks:
✅ GOOD - Shows expected format:
Expected output format:
\```
**file.kt:123** - CRITICAL: Exposes mutable state
Change MutableStateFlow to StateFlow:
...
\```Context Requirements:
✅ GOOD - Explicit about requirements:
# review-file
Reviews a specific file for quality issues.
**Usage:** /review-file path/to/file.kt
This command will read the file and analyze it against project standards.❌ BAD - Assumes context without stating:
# review-file
Reviews the file.Graceful Handling:
✅ GOOD - Handles missing info:
If no PR number provided, analyze current git diff.
If no files changed, report clean working directory.Proper Skill References:
✅ GOOD - Clear skill invocation:
# review-changes
Use the `reviewing-changes` skill to perform comprehensive code review.
This command is equivalent to directly invoking the skill but provides
a convenient shorthand for PR and commit reviews.Verify:
.claude/skills/Classify findings using reference/priority-framework.md: