Agent instructionsScan: pass

Minimal CLAUDE.md

A 30-line universal CLAUDE.md skeleton: summary, commands table, definition of done, conventions, do-not-touch list, and when to ask.

License: CC0-1.0 · By waxmark · v1 · 2026-11-02

Share on X

Add a trust badge to your README

[![Waxmark](https://waxmark.app/api/badge/minimal-claude-md)](https://waxmark.app/items/minimal-claude-md/scan)
Report
# {{PROJECT_NAME}}

{{ONE_LINE_PURPOSE}}. Stack: {{LANGUAGE_AND_FRAMEWORK}}. Entry point: `src/`. Tests: `tests/`.

## Commands

| Task | Command |
|------|---------|
| Install | `{{INSTALL_COMMAND}}` |
| Run locally | `{{DEV_COMMAND}}` |
| Test | `{{TEST_COMMAND}}` |
| Lint | `{{LINT_COMMAND}}` |
| Typecheck | `{{TYPECHECK_COMMAND}}` |
| Build | `{{BUILD_COMMAND}}` |

## Definition of done

A change is done when `{{TEST_COMMAND}}`, `{{LINT_COMMAND}}`, and `{{TYPECHECK_COMMAND}}` all exit 0 and the final command output is pasted in your report. Do not say "tests pass" without running them in this session.

## Conventions

- Match the style of the surrounding file; do not reformat code you did not change.
- Add or update a test for every behavior change, next to the existing tests for that module.
- Work on a feature branch off `{{MAIN_BRANCH}}`. Commit message: imperative subject under 72 chars, blank line, body explaining why.
- No new dependencies without naming them explicitly in the report.

## Do not touch

- `{{GENERATED_DIR}}/` is generated; edit the source and regenerate instead.
- `.env*`, lockfiles, CI workflow files, and `migrations/` unless the task is specifically about them.

## When to ask first

Stop and ask before: deleting files, changing public APIs or schemas, adding a dependency, touching auth or payments code, or running anything that mutates a remote system (deploy, publish, `git push --force`).
Minimal CLAUDE.md · Waxmark