This file gives AI coding agents the minimum context needed to work safely in this repository. It applies to the whole repo.
- Read
README.md,CONTRIBUTING.md, andCOMMUNITY_TEMPLATE_GUIDE.mdbefore changing template behavior. - Use the focused notes in
docs/agents/for repo map, template metadata, validation, and review checks. - Keep changes small and local to the affected template or script.
- Do not overwrite user work or generated files by hand.
pnpm installinstalls root tooling.pnpm generateregenerates template metadata and docs.pnpm lintvalidates template structure, metadata, Open Graph images, and formatting.pnpm formatformats repo files.
- Read
docs/agents/repository-map.mdbefore assuming current directory layout. - Do not manually edit generated files unless you are updating the generator and intentionally checking output.
- If you change a template
package.json, add/remove a template, or change metadata, runpnpm generate. - Every template directory listed in root
package.jsonrepokit.groupsmust contain apackage.jsonandog-image.png. - Never add secrets, private keys, personal wallet data, local RPC credentials, or real API tokens.
- Keep
.envfiles out of templates. Use.env.examplewhen configuration is needed, with placeholders for sensitive values and safe defaults for non-sensitive values. - For agent, MCP, wallet, or transaction automation templates, document authentication, permissions, and user approval boundaries clearly.
docs/agents/repository-map.mddocs/agents/template-authoring.mddocs/agents/template-metadata.mddocs/agents/testing-and-ci.mddocs/agents/review-checklist.mddocs/agents/known-gotchas.md