Code Review Component Skill
Table of Contents
When to use this skill
When you need a comprehensive audit of a component — not just the recent delta. Use before major refactors, when onboarding to assess quality, periodically to track technical debt, or before declaring a component "production-ready". For PR-delta reviews, use the sibling code-review-pr skill.
How to use this skill
Identify the component(s). Components live under
projects/ores.<component>/. To see all known components:./projects/ores.compass/compass.sh list --type component
- Walk the full checklist. The canonical list is Code review checklist. All categories apply here, including the "Component-only checks" section at the end (structure, CMake, PlantUML, component_overview.org).
Run the validators that automate parts of the checklist:
./projects/ores.codegen/validate_docs.sh
Score each dimension 1–5 to produce a Component Health Score:
Dimension Structure Code style Domain completeness Test coverage Documentation Security Modernisation - Bucket findings by severity (Critical / Important / Minor — see the checklist) and add an Effort estimate (Small / Medium / Large) to each.
- Group into themed stories for the sprint backlog via
agile-product-owner. Suggested themes:- Structure & CMake
- Headers & style
- Domain completeness (missing services for domain types)
- Test coverage
- Modernisation (C++23 upgrades)
- Documentation (Doxygen, diagrams)
- Security
- Summary report. Conclude with:
- The health-score table.
- Top 3–5 priority recommendations (mix of critical fixes, high-impact improvements, and quick wins).
- Overall debt level: Low / Medium / High.
Recipes
- How do I show a doc by UUID? — to inspect the component's
component_overview.organd follow its links. - How do I find docs matching a pattern? — to enumerate the component's tasks, stories, and related knowledge docs.
Reference
- Code review checklist — every category applied here.
- Component documentation guide — the doc-side contract.
- System Model — cross-component context the audit needs.
- code-review-pr — sibling skill for the delta-only review.