Repository/Directory#

• Runtime: runtime/platform, (e.g. cloudflare workers, node 20, python 3.11)
• Test command: <test command>
• Lint command: <lint command>

How to navigate this codebase#

• where primary source files live and any per-file convention
• where secondary modules live and their organization
• test layout convention, e.g. tests mirror source: src/foo.ts -> tests/foo.test.ts

Conventions#

• Testing: framework and key patterns (Links to relevant code/docs)
• other convention area: what to follow (Links to relevant code/docs)
• other convention area: what to follow (Links to relevant code/docs)

Boundaries#

• Do not <forbidden action, e.g. edit generated files in gen/>
• Do not <forbidden action, e.g. introduce new background jobs without updating config/>

Dependencies#

• Depends on: <upstream services, comma-separated>
• Depended on by: <downstream services, comma-separated>