Project File Review
Review project files across three dimensions, then suggest fixes and improvements.
Dimensions
- Consistency: Naming conventions, formatting, patterns, and style are uniform within and across files.
- Completeness: Nothing is missing. All referenced targets, commands, variables, and dependencies exist. All expected sections are present.
- Correctness: Syntax is valid. Commands work. Paths exist. Versions are compatible. Logic is sound.
Workflow
Phase 1: Individual File Review
Review each file separately. For each file:
- Read the file fully.
- Evaluate against all three dimensions.
- Report findings grouped by dimension.
- Suggest specific fixes with code snippets.
Phase 2: Cross-File Consistency
When multiple files are provided, or after individual reviews, check alignment across files:
- Verify shared references match (e.g., target names in justfile match CI workflow steps, Python version in pyproject.toml matches CI matrix and Dockerfile).
- Check that documented commands in README match actual targets/scripts.
- Confirm dependency lists are synchronized (e.g., pyproject.toml vs requirements files vs CI install steps).
- Ensure CLAUDE.md reflects the actual project structure and tooling.
Discovery Mode
When reviewing a file, suggest other project files that should be cross-checked. Common relationships:
- justfile / Makefile <-> CI workflows, README, pre-commit config
- pyproject.toml <-> Dockerfile, CI workflows, pre-commit config
- README <-> CLAUDE.md, justfile, CI workflows
- Dockerfile <-> docker-compose, CI workflows, pyproject.toml
- pre-commit config <-> CI workflows, pyproject.toml
Offer to review related files the user hasn't mentioned yet.
Output Format
For each file, report:
### <filename>
#### Consistency
- [finding + suggested fix]
#### Completeness
- [finding + suggested fix]
#### Correctness
- [finding + suggested fix]
After all individual reviews, add a cross-file section:
### Cross-File Alignment
- [inconsistency + which files + suggested fix]
Omit empty sections. Prioritize actionable findings over nitpicks.
1---2name: review-473description: Review project files for consistency, completeness, and correctness. Use when asked to review, audit, check, or validate project configuration files (justfile, Makefile, CI workflows, pre-commit config, pyproject.toml, Dockerfile, docker-compose, etc.) or documentation files (README, CLAUDE.md, CONTRIBUTING, etc.). Supports both single-file review and cross-file consistency checks.4---5
6# Project File Review
7
8Review project files across three dimensions, then suggest fixes and improvements.
9
10## Dimensions
11
12- **Consistency**: Naming conventions, formatting, patterns, and style are uniform within and across files.
13- **Completeness**: Nothing is missing. All referenced targets, commands, variables, and dependencies exist. All expected sections are present.
14- **Correctness**: Syntax is valid. Commands work. Paths exist. Versions are compatible. Logic is sound.
15
16## Workflow
17
18### Phase 1: Individual File Review
19
20Review each file separately. For each file:
21
221. Read the file fully.
232. Evaluate against all three dimensions.
243. Report findings grouped by dimension.
254. Suggest specific fixes with code snippets.
26
27### Phase 2: Cross-File Consistency
28
29When multiple files are provided, or after individual reviews, check alignment across files:
30
311. Verify shared references match (e.g., target names in justfile match CI workflow steps, Python version in pyproject.toml matches CI matrix and Dockerfile).
322. Check that documented commands in README match actual targets/scripts.
333. Confirm dependency lists are synchronized (e.g., pyproject.toml vs requirements files vs CI install steps).
344. Ensure CLAUDE.md reflects the actual project structure and tooling.
35
36### Discovery Mode
37
38When reviewing a file, suggest other project files that should be cross-checked. Common relationships:
39
40- **justfile / Makefile** <-> CI workflows, README, pre-commit config
41- **pyproject.toml** <-> Dockerfile, CI workflows, pre-commit config
42- **README** <-> CLAUDE.md, justfile, CI workflows
43- **Dockerfile** <-> docker-compose, CI workflows, pyproject.toml
44- **pre-commit config** <-> CI workflows, pyproject.toml
45
46Offer to review related files the user hasn't mentioned yet.
47
48## Output Format
49
50For each file, report:
51
52```
53### <filename>
54
55#### Consistency
56- [finding + suggested fix]
57
58#### Completeness
59- [finding + suggested fix]
60
61#### Correctness
62- [finding + suggested fix]
63```
64
65After all individual reviews, add a cross-file section:
66
67```
68### Cross-File Alignment
69- [inconsistency + which files + suggested fix]
70```
71
72Omit empty sections. Prioritize actionable findings over nitpicks.
majiayu000