39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
---
|
|
name: brooks-health
|
|
description: >
|
|
Combined codebase health dashboard that scores a project across all four quality
|
|
dimensions — PR quality, architecture, tech debt, and test quality — in a single
|
|
pass, drawing on twelve classic engineering books.
|
|
Triggers when: user wants an overall quality assessment, asks "how healthy is this
|
|
codebase?", "run all the checks", "I need a health score before the release", or
|
|
wants to onboard a new team with a quality overview.
|
|
Do NOT trigger for: server health checks, HTTP health endpoints, Kubernetes
|
|
liveness/readiness probes, database health, or application uptime. Also do not
|
|
trigger when the user specifically requests only one dimension — use the
|
|
corresponding focused skill instead (brooks-review / brooks-audit /
|
|
brooks-debt / brooks-test).
|
|
---
|
|
|
|
# Brooks-Lint — Health Dashboard
|
|
|
|
## Setup
|
|
|
|
Read in order:
|
|
|
|
1. `../_shared/common.md` — Iron Law, Project Config, Report Template, Health Score
|
|
2. `../_shared/source-coverage.md` — book coverage, exceptions, tradeoffs
|
|
3. `../_shared/decay-risks.md` — production risk symptoms
|
|
4. `../_shared/test-decay-risks.md` — test risk symptoms
|
|
5. `health-guide.md` (this directory) — the dashboard orchestration process
|
|
|
|
## Process
|
|
|
|
**Scope:** if the user did not specify a project or directory, apply Auto Scope Detection
|
|
(`../_shared/common.md`) first.
|
|
|
|
1. Run abbreviated scans across all four dimensions (Step 1 of the guide)
|
|
2. Compute per-dimension and composite Health Scores with weighting (Step 2 of the guide)
|
|
3. Output the Health Dashboard using the dashboard report template (Step 3 of the guide)
|
|
|
|
**Mode line in report:** `Health Dashboard`
|