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

  1. Identify the component(s). Components live under projects/ores.<component>/. To see all known components:

    ./projects/ores.compass/compass.sh list --type component
    
  2. 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).
  3. Run the validators that automate parts of the checklist:

    ./projects/ores.codegen/validate_docs.sh
    
  4. Score each dimension 1–5 to produce a Component Health Score:

    Dimension
    Structure
    Code style
    Domain completeness
    Test coverage
    Documentation
    Security
    Modernisation
  5. Bucket findings by severity (Critical / Important / Minor — see the checklist) and add an Effort estimate (Small / Medium / Large) to each.
  6. 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
  7. 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

Reference

Emacs 29.1 (Org mode 9.6.6)