project-health-check
Skill1 starsChanged 11 days agoMITView on GitHub
Audit existing projects before new work. Use when entering a codebase for the first time or after a gap. Do NOT use for new projects with no existing code.
We split this skill into the rules it gives an agent
7 rules. 0 are common, 5 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 4 edited versions we read keep these.
5
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 26
Before "significant change" (>3 files or new feature).
- Distinctive: line 89
Write report in project root.
- Very specific: line 125
Create REMEDIATION.md with ordered tasks.
- Distinctive: line 145
If C: Add WARNING comment at top of new files.
- Distinctive: line 157
After remediation: Re-run immediately.
- Very specific: line 166
Check HEALTH-CHECK.md → 14 days old.
- Distinctive: line 171
Document. Build with CSS custom properties (prep for token migration).
“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Project Health Check
No new code until this completes.
Diagnose before operating. Audit against engineering standards. Surface misalignments. Force conscious decision: fix first, or proceed with documented risk.
When to Use
MANDATORY when:
- Project has code AND no
HEALTH-CHECK.mdwithin 7 days. - User asks for audit, health check, or technical debt review.
- Return after gap >3 days.
- Before "significant change" (>3 files or new feature).
When NOT to Use
- Project initialized this session (already compliant)
- Single-line fix in an audited project with recent HEALTH-CHECK.md
Output Contract
| Artifact | Format | Location | Quality Criteria |
| HEALTH-CHECK.md health report | Markdown report with summary, stack/structure/quality/config/dependency/workflow audit, drift detection, recommendations | Root (HEALTH-CHECK.md) | Audit covers 6 categories (stack, structure, code quality, config, dependencies, workflow), drift detected between docs and reality (stats, version, features, commands, links), user explicitly chose A (fix), B (proceed with caution), or C (ignore with risk), decision documented, re-audit date set within 7 days |
Core Process
Phase 0 — Detect Context
- Check
HEALTH-CHECK.md:- Within 7 days → Read. Skip to Phase 3 (Re-audit decision).
- Older than 7 days → Read, then Phase 1.
- Missing → Phase 1.
- Check
AGENTS.md: Missing → HIGH risk. - Check
SPEC.md: Missing → decisions undocumented.
Phase 1 — Full Audit
NO CODE WRITTEN.
→ See guides/AUDIT-CHECKLIST-GUIDE.md for complete 6-category checklist (stack, structure, code quality, config, dependencies, workflow compliance).
For each check: record PASS, WARN, FAIL.
Phase 1b — Drift Detection
Inspired by Sub-Zero Skill. Check for drift between what docs claim and what's actually true.
| Drift Type | Check | How |
| Stats drift | README says "38 skills" but count differs | ls skills/ | wc -l vs README claim |
| Version drift | VERSION file != README badge | cat VERSION vs grep badge in README |
| Feature drift | Docs mention feature X, X doesn't exist | Grep for feature references, verify existence |
| Command drift | README says npm test, project uses cargo test | Check STACK_CONFIG.md vs actual |
| Link drift | Docs reference page X, X doesn't exist | Check internal links |
Output drift as:
⚠️ DRIFT: [description] — expected [X], found [Y]Drift is a WARNING, not a BLOCKER. Document it, let user decide.
Phase 2 — Generate Report
→ See guides/REPORT-TEMPLATE-GUIDE.md for HEALTH-CHECK.md template.
Write report in project root. Include: summary, stack versions, structure, code quality, recommendations (prioritized), decision log.
Rules: Honest. No sugarcoat. Link files and line numbers. Distinguish blocking vs non-blocking. One-sentence impact per issue.
Phase 3 — User Decision Gate (BLOCKING)
FULL STOP. Present report. Wait explicit decision.
🏥 PROJECT HEALTH CHECK COMPLETE
[Summary: X critical, Y warnings, Z passes]
Top issues:
1. [Most critical]
2. [Second most critical]
...
Options:
A. FIX FIRST — Remediation plan, fix criticals before new features.
B. PROCEED WITH CAUTION — Document risks, build without degrading standards further.
C. IGNORE — Proceed as requested, note technical debt increase.
→ What do you choose?Valid: "A"/"Fix first" → Phase 4. "B"/"Proceed" → Phase 5. "C"/"Ignore" → Phase 5 with risk.
Invalid: Vague "ok" or "sure". Ask again with explicit options.
Phase 4 — Remediation (If A)
- Create
REMEDIATION.mdwith ordered tasks. - Invoke
planning-and-task-breakdown. - Execute ONE AT A TIME.
- Re-run health check after.
- Then proceed to original request.
Example tasks: Upgrade Next.js, migrate tailwind.config.ts → CSS @theme, replace Inter → distinctive font, add Vitest, create SPEC.md.
Phase 5 — Proceed with Risk (If B or C)
- Append to
HEALTH-CHECK.md:## Decision - **Chosen:** B - **Date:** YYYY-MM-DD - **Rationale:** [Reason] - **Accepted risks:** [List] - If C: Add WARNING comment at top of new files.
- Proceed to original request.
Recursive Behavior
Re-audit every 7 days. Codebases rot fast.
- New session: Check
HEALTH-CHECK.mdage. 7 days: Re-run full audit before significant work.
- <=7 days: Read
HEALTH-CHECK.md, verify no new criticals. - After remediation: Re-run immediately.
Examples
User: "Add dark mode toggle."
Agent:
- Check
HEALTH-CHECK.md→ 14 days old. - Run full audit.
- Find: Next.js 14, no
DESIGN.md, hardcodedbg-gray-900. - Report: 2 critical, 4 warnings.
- Present A/B/C. User chooses B.
- Document. Build with CSS custom properties (prep for token migration).
Common Rationalizations
| Excuse | Response |
| "User wants quick fix, don't slow them." | 5-min audit prevents hours debugging degraded codebase. |
| "Audited last week, probably fine." | Codebases rot in days. Re-audit mandatory. |
| "User didn't ask for audit." | Doctor doesn't wait for patient to ask for diagnosis. |
| "No time to fix everything." | Option B exists for reason. |
| "Someone else's mess." | Any code we touch becomes our responsibility. |
| "I'll match existing style." | Matching slop creates more slop. |
Red Flags
- Agent writes code before checking
HEALTH-CHECK.mdage. - Agent ignores failing checks without user confirmation.
- Agent "fixes" silently without documenting.
- User says "just do it" and agent doesn't present A/B/C.
- Agent audits but doesn't write
HEALTH-CHECK.md. - Agent uses bad patterns (
bg-blue-500) in new code.
Verification
HEALTH-CHECK.mdexists and dated.- Existing project: Audit before new code.
- Returning project: Audit age checked.
- User explicitly chose A, B, or C.
- Decision documented in
HEALTH-CHECK.md. - If B/C: Risks listed and accepted.
- New code doesn't replicate red flags found.
- Drift detected between docs and reality (stats, version, features, commands, links).
Troubleshooting
| Problem | Fix |
| Audit takes too long | Sample 10 files max per category, note "sampled". |
package.json missing | Adapt checks for Python/Go/Rust. |
| User frustrated by gate | Emphasize: prevents debugging later. |
| Health check always failing | Review if standards fit project maturity. |
| User always chooses C | Explain long-term cost, respect autonomy. |
Other versions6 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 6
- pnp/sharepoint-skills★ 142same name
- claude-world/director-mode-lite★ 80same name
- xmqywx/claude-code-skills★ 2same name
- dss-time/repo-doctor-skills★ 1same name
- ilamanov/skills★ 1same name
- laojin1900/365Skill★ 1same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository59 other files it gives its agents.
- AGENTS.mdAGENTS.md
- templates/CLAUDE.mdCLAUDE.md
- adapt-skillSkill
- api-and-interface-designSkill
- architecture-analysisSkill
- audit-skillSkill
- backend-api-masterySkill
- browser-testing-with-devtoolsSkill
- ci-cd-and-automationSkill
- clarify-skillSkill
- cli-toolsSkill
- code-review-and-qualitySkill
- code-simplificationSkill
- context-engineeringSkill
- critique-skillSkill
- customize-opencodeSkill
- debugging-and-error-recoverySkill
- debugging-three-strikesSkill
- delight-skillSkill
- deprecation-and-migrationSkill
- dev-environment-auditSkill
- documentation-and-adrsSkill
- doubt-driven-developmentSkill
- engineering-fundamentalsSkill
- frontend-desktopSkill
- frontend-mobileSkill
- frontend-pwaSkill
- frontend-ui-engineeringSkill
- frontend-webSkill
- fullstack-shippingSkill
- gateSkill
- git-init-and-versioningSkill
- git-workflow-and-versioningSkill
- hard-skillSkill
- idea-refineSkill
- incremental-implementationSkill
- industrial-brutalist-uiSkill
- interview-meSkill
- minimalist-uiSkill
- multi-agent-orchestrationSkill
- observability-and-instrumentationSkill
- optimize-skillSkill
- output-skillSkill
- performance-optimizationSkill
- planning-and-task-breakdownSkill
- polish-skillSkill
- project-metricsSkill
- redesign-skillSkill
- security-and-hardeningSkill
- self-improvementSkill
- shipping-and-launchSkill
- skill-creatorSkill
- skill-improverSkill
- soft-premium-uiSkill
- source-driven-developmentSkill
- spec-driven-developmentSkill
- test-driven-developmentSkill
- typeset-skillSkill
- user-onboardingSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

