Skip to content

05-review

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

05-review

README.md

Review & Audit Workflows

This directory contains workflows for reviewing code quality, performance, and maintainability.

Workflow Index

File Purpose When to Use
01-code-review.md General code review for defects and risks Before merging, periodic audits
02-code-optimization.md Performance-focused analysis When performance issues suspected
03-code-refactoring.md Code quality and technical debt When code is hard to maintain
04-website-data-refactoring.md Website content/data organization When data is scattered or untyped

Quick Decision Guide

What are you looking for?
         │
         ├── Bugs, defects, security risks
         │   └── Use 01-code-review.md
         │
         ├── Performance bottlenecks, resource usage
         │   └── Use 02-code-optimization.md
         │
         ├── Code quality, maintainability, tech debt
         │   └── Use 03-code-refactoring.md
         │
         └── Scattered/untyped website content, data organization
             └── Use 04-website-data-refactoring.md

Workflow Relationships

Workflow Focus Typical Severity When to Run
01-code-review Bugs, risks, defects S0-S2, P0-P2 Before merge, regular audits
02-code-optimization Performance S1-S2, P1-P2 Performance issues, scaling
03-code-refactoring Maintainability S2-S3, P2-P3 Tech debt, before new features
04-website-data-refactoring Data organization S2-S3, P2-P3 Content scattered, CMS prep

Shared Elements

All workflows use:

  • Severity scoring: S0 (Critical) → S3 (Low)
  • Priority scoring: P0 (Blocker) → P3 (Backlog)
  • Parallel agents: 3-5 agents scanning different aspects
  • Output format: Report saved to project/plans/ with findings ordered by priority

See ../00-Meta-Workflow/00-meta/severity-priority-rubric.md for the full scoring rubric.

Running Multiple Reviews

You can run multiple workflows on the same codebase:

  1. Comprehensive audit: Run all four sequentially
  2. Pre-release: Run 01-code-review (required) + 02-optimization (if applicable)
  3. Tech debt sprint: Run 03-code-refactoring first, then plan implementation
  4. Content cleanup: Run 04-website-data-refactoring before CMS integration

When running multiple reviews:

  • Findings may overlap (e.g., a performance issue that's also a bug)
  • Consolidate findings into a single implementation plan
  • Deduplicate before prioritizing

Output Location

All workflows save reports to project/plans/ using the standard naming convention defined in ../00-meta/naming-conventions.md:

  • project/plans/code-review-YYMMDD-HHMM-{model}.md
  • project/plans/code-optimization-YYMMDD-HHMM-{model}.md
  • project/plans/code-refactoring-YYMMDD-HHMM-{model}.md
  • project/plans/website-data-refactoring-YYMMDD-HHMM-{model}.md

Related Workflows