917 B
917 B
Repository instructions
Product purpose
[Describe the product and critical behavior in 2–5 sentences.]
Repository structure
[path]: [purpose][path]: [purpose]
Required commands
- Install:
[command] - Format check:
[command] - Lint:
[command] - Typecheck:
[command] - Tests:
[command] - Build:
[command] - Smoke test:
[command]
Only include commands that are verified or clearly marked as needing confirmation.
Engineering constraints
- [Backwards-compatibility policy]
- [Dependency policy]
- [Migration policy]
- [Documentation expectations]
Protected paths and data
- Do not modify:
[path] - Do not read or expose secrets from:
[path/pattern] - Treat runtime/user data under
[path]as protected.
Completion standard
A task is complete only when relevant checks pass and the final report states changed files, validation evidence and unresolved items.