agentleFS
ku5icku5ic/claude-kit/skills/report-format/SKILL.md

report-format

Skill2 starsChanged 8 days agoMITView on GitHub

Load before writing an audit, review, or dependency report.

4 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 2 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    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. Distinctive:

    If a section would be empty, omit it.

    line 53
  2. Distinctive:

    No ASCII decoration, no banner comments, no emoji.

    line 54
  3. Very specific:

    Does not govern /write or /pr output (commit messages, release notes, stakeholder summaries, PR descriptions, review comments).

    line 56

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

Markdown report format

Consistent format for findings reports: audits, reviews, dependency runs, and any other structured list of problems found. A skill that defines its own report template (investigate) owns its shape; only the file-naming, path-printing, and ASCII rules below apply to those.

Required sections

# <Report type>: <target>

Generated: <ISO timestamp>
Scope: <file, component, or module>
Stack: <the language lines kit detect-stack prints, if applicable>

## Summary

<One paragraph. What was checked, what was found, overall health in one word.>

## Findings

### <Finding title>

- Severity: <failure | warning | info>
- Location: <file>:<line> or <region>
- What: <problem in one or two sentences>
- Evidence: <what was checked and what it showed: a count, a repro and its rate, a quoted line>
- Why it matters: <one sentence>
- Fix: <code snippet or concrete instruction>
- Refs: <WCAG criterion, CVE, doc link, etc., if relevant>

### <Next finding>

...

## Cannot be verified statically

<Items that need runtime checks, user testing, or external tools. Omit section if empty.>

## Out of scope

<Things noticed but not part of the task. Omit if empty.>

Rules

  • Severity is one of failure (a defect or violation that should not ship), warning (a smell that compounds with other findings), info (a hardening opportunity or note, not a defect). Nothing else. A consumer may narrow a level's meaning for its domain, never add one.
  • Sort findings by severity, failures first.
  • If a section would be empty, omit it. Do not leave placeholder text.
  • No ASCII decoration, no banner comments, no emoji.
  • File naming and location: the path kit scratch-dir <kind> <target-slug> prints.
  • Does not govern /write or /pr output (commit messages, release notes, stakeholder summaries, PR descriptions, review comments); those have their own formats per rules/output.md.

Summary line rubric

The "overall health in one word" at the end of the Summary helps quick scanning:

  • clean (no findings)
  • minor (only info)
  • moderate (warnings, no failures)
  • serious (failures present)
  • broken (multiple critical failures, work should pause)

Anti-patterns

  • failure: writing the report body to terminal output instead of a file: the artifact becomes ephemeral and unreferenceable.
  • failure: omitting the ## Summary section or the ## Findings section when findings exist, in a report this format governs.
  • warning: inventing severity levels outside failure, warning, info, e.g. critical, high, medium, low, error. The rubric has three levels; anything else breaks downstream tooling that parses reports.
  • warning: leaving placeholder text in empty sections (e.g. <none>, N/A) rather than omitting the section.
  • info: not sorting findings by severity (failures first, then warnings, then info).

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.