mcpField
R
repo-audit

repo-audit

github.com/paulnsorensenDevelopment063 installsUpdated 1w ago
Repository

About repo-audit

repo-audit is a read-only repository survey that identifies which catalog skills apply and proposes an order based on dependencies. It reports and routes findings without editing files or making mutating API calls.

Key features

  1. 01Inspect repository files and configuration
  2. 02Report status for each catalog skill
  3. 03Output results as JSON or Markdown
  4. 04Optionally read GitHub repository settings
  5. 05Order follow-up work by dependencies

Use cases

  1. 01Find repository maintenance checks that are missing
  2. 02Decide the order for running catalog skills
  3. 03Prepare audit results for scripts or PR comments

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/paulnsorensen/git-gouda --skill repo-audit

After installing, type/repo-auditin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

evals/
evals.json
references/
checks.md
scripts/
repo_audit.py

Details

From the project README

repo-audit

A read-only survey of a repository against every other catalog skill's setup checks. It answers one question: which catalog skills apply here, and in what order?

What this skill is NOT for

  • Applying a fix — a finding routes to the skill that owns it (oss-hygiene, gh-bootstrap, and so on); this skill never edits a file or calls a mutating API.
  • Code review of application logic, tests, or business behavior — out of scope.
  • Replacing a catalog skill's own protocol — the audit is a triage pass, not a substitute for reading that skill's SKILL.md.

Protocol

1. Run the bundled script from the repository root
python3 skills/repo-audit/scripts/repo_audit.py

Add --github to also run read-only gh api GET calls (merge settings, rulesets, delete_branch_on_merge, the CODEOWNERS errors endpoint). --github is opt-in; the default run only reads the working tree and local git metadata (git tag --list, git remote get-url origin).

Use --json for machine consumption or --markdown to paste the table into a PR comment. The script always exits 0 unless it errors itself — a missing or warn row is not a script failure.

2. The script checks, read-only, one row per catalog skill
CheckWhat it inspectsRoute to
prekprek.toml or .pre-commit-config.yamlprek
oss-hygieneLICENSE, CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, .github/ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE, .github/dependabot.yml, plus scorecard/codeql/dependency-review workflow presenceoss-hygiene
gh-bootstrap.github/release.yml; with --github also merge settings and non-empty rulesetsgh-bootstrap
safe-settings.github/settings.yml (informational)safe-settings
config-review-bot.coderabbit.yamlconfig-review-bot
releasegit tag --list and CHANGELOG.mdrelease
justfilejustfilejustfile
ci-optimizeworkflows present with concurrency: (informational)ci-optimize
build-optimizeskipped — needs measured wall-time databuild-optimize
github-copilot-repo-instructions.github/copilot-instructions.md or .github/instructions/*.instructions.mdgithub-copilot-repo-instructions
codeownersCODEOWNERS in root, docs/, or .github/; with --github also the codeowners/errors endpointcodeowners
actions-pinningcount of uses: refs not pinned to a 40-hex commit SHAactions-pinning
pr-title-linta workflow containing action-semantic-pull-request or commitlintpr-title-lint
labels-as-code.github/labels.yml or .github/labeler.ymllabels-as-code
repo-attributes.gitattributes, .editorconfig, .gitignorerepo-attributes
branch-cleanupwith --github, delete_branch_on_mergebranch-cleanup
agents-mdAGENTS.md exists, under 32 KiB, under about 200 linesagents-md

Each row's status is pass, warn, missing, or skipped. skipped means the check needs data this script cannot gather statically (build-optimize) or needs --github and it was not passed (branch-cleanup), not that the repository failed the check.

3. Read the table and propose an ordered plan

After the script prints its table, read the missing and warn rows and propose an ordered plan that names the catalog skill for each gap. Order gaps by dependency where one exists (for example, gh-bootstrap locks the merge surface before oss-hygiene adds contributor-facing files; actions-pinning matters more once workflows exist). Do not apply any fix yourself — hand each gap to its named skill.

4. No writes, no mutating calls

This skill and its script never create, edit, or delete a file, and never call a POST, PATCH, PUT, or DELETE GitHub API endpoint. --github only adds GET calls. If a user asks the audit to "just fix it", decline and restate the routing plan from step 3 instead.

References

  • references/checks.md — one row per check, the file or endpoint it inspects, and a docs.github.com citation where an API is used.

Comments

Markdown supported