feat: repo health & onboarding-readiness report (HEALTH.md)#47
Merged
Conversation
Add a deterministic (AI-free) repo-health analysis that scores how onboarding-ready a repository is across documentation, community, quality, and automation signals, producing HEALTH.md with a weighted 0-100 score, A-F grade, and prioritized recommendations. - New src/health.ts: computeRepoHealth + generateHealthDocs + getHealthGrade - Wire into the generation pipeline gated by the new showHealth style section (on for all packs except minimal) - Surface a Repo Health summary line and HEALTH.md in the CLI run output - Export via ./health subpath and src/api.ts re-exports - Unit tests (test/health.test.ts) + CLI e2e assertion that HEALTH.md is generated - README + CHANGELOG updates Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a deterministic (AI-free) repo-health & onboarding-readiness report ā a new flagship
HEALTH.mddocument that scores how easy a repository is for a new contributor to get productive in.It answers the onboarding question the README poses ("Most READMEs are outdated⦠most wikis incomplete") with hard signals: does the project have docs, community files, quality tooling, and automation?
What it checks
Computed entirely from the file scan (stable across runs), grouped into four categories with weighted scoring:
.gitignoreOutput: a weighted 0ā100 score + AāF grade, per-category status tables, and a prioritized list of recommendations (highest-impact gaps first).
Meta-file detection is anchored to the repo root and conventional meta dirs (
.github/,docs/), so a source file likesrc/security.tsis never mistaken for a SECURITY policy.Changes
src/health.tsācomputeRepoHealth(),generateHealthDocs(),getHealthGrade()analysis-orchestration.ts), gated by a newshowHealthstyle-pack section (enabled for all packs exceptminimal)bootcamprun summary now prints a Repo Health line;HEALTH.mdlisted in generated files./healthpackage subpath export + re-exports fromsrc/api.tsTesting
test/health.test.tsā 13 unit tests (scoring, grade thresholds, warn=half-weight, path anchoring, CI/test-naming detection, Windows path normalization, doc rendering, empty-scan safety)test/e2e/cli-main.e2e.test.tsto assertHEALTH.mdis produced by the real CLI processlintā,typecheckā,buildā, full unit suite 1032 passing, CLI e2e ā