Repo hygiene audit
Use when auditing a software repository for beginner-level best-practice violations, repo health, Git history hygiene, issue and PR usage, branch discipline, tests, docs, coding style, CI, security basics, or maintainability signals.From its SKILL.md
npx -y skills add CodingThrust/Templates --skill repo-hygiene-auditAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 10 stars10 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
3.0 KB, as published. Nobody here has run it
Repo Hygiene Audit
Overview
Audit a repository as a beginner-friendly scorecard. Ground every judgment in visible evidence, and give concrete next steps instead of vague advice.
Workflow
- Inspect the repo root and project instructions first.
- Read core files: README, license, package/build files, test layout, docs, CI, issue templates, PR templates, security policy, contribution docs, and gitignore.
- Inspect Git history and branches with read-only commands.
- Run only safe, cheap verification commands if they are obvious from the repo.
- Produce the scorecard, then list the highest-leverage fixes.
Use these references as needed:
references/scorecard-rubric.md: default checks and severity rules.references/git-history-audit.md: commit, branch, issue, and PR checks.
Evidence Commands
Prefer read-only commands:
pwd
find . -maxdepth 3 -type f | sort | head -200
git status --short
git branch -a -vv
git log --oneline --decorate --all -n 120
git remote -v
find .github -maxdepth 3 -type f | sort
If GitHub CLI is configured, optionally enrich the local evidence:
gh pr list --state all --limit 30 --json number,title,state,headRefName,baseRefName,mergedAt,closedAt,author
gh issue list --state all --limit 30 --json number,title,state,labels,createdAt,closedAt,author
Do not rewrite history, delete branches, push, create issues, or edit files unless the user explicitly asks for remediation.
Output Format
Start with a compact summary:
Overall: Warn
Best signals: ...
Highest-risk gaps: ...
Recommended first fixes: ...
Then provide a scorecard:
| Area | Status | Evidence | Why it matters | Next step |
|---|---|---|---|---|
| README | Pass | README.md has setup and examples | New users can start | Keep current |
Use statuses exactly:
Pass: visible evidence meets beginner expectations.Warn: usable, but confusing, incomplete, stale, or inconsistent.Fail: missing or likely to block contributors.Not visible: cannot be assessed from local evidence.
End with a short prioritized fix list. Keep it practical and ordered by value.
Scoring Guidance
Do not over-penalize small or early repos. A beginner repo can still pass if it has clear setup, tests, and review flow.
Use Fail for gaps that block basic collaboration:
- No README or setup path.
- No obvious way to run tests.
- No license for a public/open-source repo.
- Git history has no issue/PR traceability.
- Secrets or generated heavy artifacts are committed.
- CI exists but cannot protect the main workflow.
Use Warn for teachable inconsistencies:
- Vague commits such as
update. - Stale local branches.
- Mixed branch naming.
- Missing issue or PR templates.
- Sparse docs or examples.
- Style commands exist but are not documented.