agentleFS
andeeplusandeeplus/aplus/skills/audit/SKILL.md

audit

Skill2 starsChanged 38 days agoMITView on GitHub

Audit a codebase area's design and defects into local notes, file the findings as issues, and carry the refactor program to merged PRs. Use to audit an area, plan a refactor program, file issues from audit findings, execute an audit's issues, or add another author's review to an existing audit.

  • Reads credentials

194 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use delight, teach-impeccable and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • HK-hubSkill

    delight

    Add moments of joy, personality, and unexpected touches that make interfaces memorable and enjoyable to use. Elevates functional to delightful. Use when the user asks to add polish, personality, animations, micro-interactions, delight, or make an interface feel fun or memorable.

    Also in 32 projects that use this

  • HK-hubSkill

    teach-impeccable

    One-time setup that gathers design context for your project and saves it to your AI config file. Run once to establish persistent design guidelines.

    Also in 19 projects that use this

  • zwy123zwySkill

    normalize

    将用户随意输入的提示词规范化为结构清晰、便于大模型执行的标准化提示词。适用于需要整理、统一提示词格式时调用。

    Also in 19 projects that use this

  • SkillPilotCHSkill

    level-up

    Eine Automatisierung pro Woche finden, scopen, shippen. Output landet als proposed-Eintrag in cadence.md mit konkreten Implementations-Schritten.

    Also in 12 projects that use this

  • ww-w-aiSkill

    pm-discovery

    PM Agent Team - Automated product discovery, strategy, and PRD generation. Runs PM analysis workflow to produce comprehensive PRD before PDCA Plan phase.

    Also in 3 projects that use this

  • +7 more from HK-hub

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 175 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Mirrors: only receive copies, from --sync, and never lose a file the working copy loses.

    line 38
  2. Distinctive:

    Ask the open questions in one round.

    line 63
  3. Distinctive:

    Write nothing until scope and posture are confirmed.

    line 74
  4. Distinctive:

    Create the files with scripts/new-audit.mts, then fill them in.

    line 78
  5. Distinctive:

    If the program is done, ask before closing its tracking issue.

    line 101
  6. Distinctive:

    Ask whether to continue with a spawned audit, work on a decision, or stop.

    line 102

“Common” is measured: kept by at least 6 in 10 of the 175 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Audit

clarify → audit → issues (on request) → execute (on request) → hand off

Use the project's domain terms (CONTEXT.md or its equivalent, when present). The audit is local working notes. An issue on the project's tracker carries the intent of a change and outlives the audit; the audit entries it covers are the steps its builder reads. Anything that must outlive the audit becomes an issue.

Rules

  • Correct over convenient. Choose the long-term right fix. No workarounds, stubs, or docs that paper over a bad contract.
  • Push for truth. Types, tests, runtime behaviour and docs must agree.
  • Sync after every change. Each time you write, edit or create anything in the audit dir, including issue drafts, manifest.json and tracks.md, run new-audit.mts --sync. With no mirror it does nothing, so always run it.
  • Ask when the audit is missing. An audit lives only in the audit dirs. Before reading one, run new-audit.mts --find [scope-slug]. When it exits 1, such as on a fresh clone or another machine, ask the user where the audit is, or whether to work from the tracker's issues alone. For the issues alone, take the tracker and project from the project's instructions, asking when they do not name them, then read the tracking issue and its children with the platform skill (github or atlassian) and run Execute with each issue's acceptance as the steps.

References

TaskRead
File the findings as issuesreferences/issues.md
Execute the program's issues with deliverreferences/execute.md

Posture

PostureStandardFiles
strict (default)Apply code-quality in full. It is written for a branch diff: treat the audited area as the change, and skip its rules about what a single PR adds, such as a file growing past a line limit.All four
balancedReal bugs and structural regressions only. Mention simplifications briefly, and push for a large refactor only when the path is obvious. Skip legibility nits.README.md, bugs.md

Files

Artifacts go under the audit dir. Check that it is gitignored when it is inside the repository; if it is not, ask before adding it to .gitignore.

  • APLUS_AUDIT_DIRS: in the environment or the repository's .env, a list of dirs separated by commas. The first is where you work and defaults to .audit; the others are mirrors, such as a notes vault. {project} in an entry becomes the repository's name, so one value serves every project: APLUS_AUDIT_DIRS=.audit,/Users/me/Vault/audits/{project}.
  • Mirrors only receive copies, from --sync, and never lose a file the working copy loses.
{audit dir}/{scope-slug}/{YYYY-MM-DD}/
  README.md                from assets/readme.md: verdict, priorities, open questions a maintainer must answer,
                           every external package, doc or link consulted, and links to the files below
  bugs.md                  one "## {bug-key}: title" per defect: problem, failure scenario, evidence
  program.md               one "## {theme-key}: title" per structural theme, with its refactor moves
                           under it as "### {move-key}: title" (strict)
  notes.md                 patterns the area follows or breaks, and what works and must survive a refactor (strict)
  review-{author-slug}.md  further authors' reviews
  synthesis.md             cross-audit only: where the authors agree and differ
  issues/                  issue drafts and manifest.json
  tracks.md                the track plan, when the program is executed
{audit dir}/handoffs/      handoff notes, one per paused branch, written by the handoff skill

A relative audit dir resolves against the primary checkout, so every worktree shares one audit, and removing a worktree keeps it. --sync copies handoff notes to the mirrors too.

  • Date folder: the date the program's first audit started. Everything for that program, including other authors' reviews, drafts and later days' work, stays in it, so the drafts share one manifest.json.
  • Author slug: kebab-case, such as claude-opus.
  • Keys are short and stable (B1, T2, and M2.1 for a move under T2); each issue draft lists the ones it covers.

Clarify

Ask the open questions in one round; skip what the request already answers.

TopicOptionsDefault
ScopeA folder, package or subsystemInferred from the request
Posturestrict or balancedstrict
BaselineThe current tree, or a branch or commitThe current tree
Cross-auditOne author, or several models auditing independentlyOne author
IssuesAudit only, or also file issuesAudit only
Issue sizefinding, pr or outcome (create-issue: size)pr

Write nothing until scope and posture are confirmed.

Audit

Create the files with scripts/new-audit.mts, then fill them in. It writes the date folder, fills the templates in assets/, and stops when an audit dir inside the repository is not gitignored. Never create them by hand.

node --experimental-strip-types <this skill's folder>/scripts/new-audit.mts <scope-slug> --author <author-slug> --model <model> [--posture strict|balanced]
node --experimental-strip-types <this skill's folder>/scripts/new-audit.mts <scope-slug> --author <author-slug> --model <model> --review
node --experimental-strip-types <this skill's folder>/scripts/new-audit.mts --sync
node --experimental-strip-types <this skill's folder>/scripts/new-audit.mts --find [scope-slug]
node --experimental-strip-types <this skill's folder>/scripts/new-audit.mts --excerpt <date-folder> <key>...
  • First run: the command without --review writes the files for the posture.
  • Another author's review: --review adds review-{author-slug}.md. Do not rewrite the first run's files.
  • Sync: --sync copies the working copy to every mirror. The first two commands sync on their own.
  • Find: --find prints the audits in the working copy, or the one for a scope, and exits 1 when there are none.
  • Excerpt: --excerpt prints the bug, theme or move for each key. A theme includes its moves. It exits 1 when a key has no section.
  • Cross-audit: the first author writes the full set. Each further author writes only review-{author-slug}.md from the same template, without reading the first author's files until their own findings are written. Once every author's file exists, write synthesis.md before drafting issues.

Hand off

The program is done when every change sub-issue is closed; the tracker may not close the tracking issue by itself. When it is done, the deliver run ends, or the user stops:

  1. Summarize what shipped: PRs merged, issues closed, key outcomes.
  2. List the open decisions and any spawned audits not yet started.
  3. If the program is done, ask before closing its tracking issue.
  4. Ask whether to continue with a spawned audit, work on a decision, or stop. Start nothing without confirmation.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.