A worked example, rendered from real sample data. Sign in to run the tool on your own input.
README.md
package.json
package-lock.json
.gitignore
src/index.ts
src/auth/session.ts
tests/session.test.ts
.github/workflows/ci.yml
dist/index.js
.env═══ Health Score ═══
Score: 37/100 (grade F, bare)
Bar: ██████████░░░░░░░░░░░░░░░░░░
Profile: oss
Files listed: 10
Essentials present: 5 of 16
Penalty: -6 for files that should not be committed
ℹ The score is computed from the file listing you pasted. This tool cannot read a repository, so it knows nothing about test coverage, commit activity or issue counts.
═══ Checklist ═══
✗ LICENSE (worth 9 pts) — Without one, nobody may legally use or contribute to the code.
✗ SECURITY (worth 7 pts) — Tells a finder where to send a vulnerability instead of opening a public issue.
✗ CONTRIBUTING (worth 6 pts) — Answers the questions every first-time contributor asks in an issue.
✗ Issue templates (worth 5 pts) — Turns "it does not work" into a reproducible report.
✗ Pull request template (worth 5 pts) — Makes authors state scope and testing before a reviewer asks.
✗ CHANGELOG (worth 5 pts) — Consumers of a released package need to know what changed.
✗ Automated dependency updates (worth 5 pts) — Security patches arrive as PRs instead of arriving as an incident.
✗ Linter config (worth 5 pts) — Catches a class of bug before review does.
✗ CODE_OF_CONDUCT (worth 4 pts) — GitHub surfaces it in the community profile and it sets the ground rules.
✗ Docs directory (worth 4 pts) — A README cannot hold everything a library needs to explain.
✗ Editor or format config (worth 3 pts) — Ends the whitespace-only diffs.
✓ README — README.md
✓ Test files — tests/session.test.ts
✓ CI configuration — .github/workflows/ci.yml
✓ .gitignore — .gitignore
✓ Dependency lockfile — package-lock.json
═══ Should
…
Score a repository's essentials from a pasted file listing (README, LICENSE, CI, tests, templates) with fixes. Part of the DevTools Surf developer suite. Browse more tools in the DevOps / CI-CD collection.