Imported from Sammybro11/dotfiles (
.config/agents/skills/report/SKILL.md). Install upstream withnpx skills add Sammybro11/dotfiles --skill report. Copyright stays with the author.
Cited technical report
Produce a markdown report on the target (repo, subsystem, directory, or paper
- its code). Default output:
reports/<slug>.mdwith a.provenance.mdsidecar.
Procedure
- Read the target code end-to-end before writing anything. Trace the real execution flow, not the README's description of it.
- Compare against standard practice: for physics code, that means published
reference implementations, standard libraries doing the same job (e.g.
emceevs hand-rolled MCMC,pymatchingvs lookup decoder), and the papers the code cites. - Findings, each with:
- Citation:
path/file.py:LINE— every claim traceable, no exceptions - Severity:
critical(wrong results) /bug(will fail in real use) /smell(maintainability) /polish - Why it matters in one sentence, and the smallest fix
- Citation:
- Hunt for the second bug — one finding means keep looking. Check the usual suspects deliberately: path-case sensitivity, dead code, duplicated definitions drifting apart, unstated assumptions (seeds, shot counts, directory-relative imports), Python-version-dependent syntax.
- Verify before publishing: re-read every cited line; confirm line numbers and quotes are accurate. Run any check that is runnable.
- Structure: Summary → What the code does well (be honest) → Findings by severity → Comparison to standard practice → Recommended order of fixes.
Rules
- Never report a bug you haven't traced to a line and reasoned through; show the failing input or condition, not a hunch.
- Distinguish "wrong" from "not what I would have written". Taste is not severity.
- If the report claims something is correct, that claim needs evidence too.