| name | project-conventions |
| description | Core conventions and patterns for this codebase |
| domain | project-conventions |
| confidence | medium |
| source | template |
Context
This is a starter template. Replace the placeholders below with conventions that are actually true for the project created from this template.
Patterns
Error handling
Describe how errors should be surfaced, logged, and recovered from.
Testing
Document where tests live, how to run them, and what must be covered when behavior changes.
Code style
Record formatting, linting, naming, and review expectations used in the repository.
File structure
Explain the purpose of major directories so agents and contributors know where changes belong.
Examples
docs/ — published site assets and generated data
news/ — weekly discovery outputs
scripts/ — automation utilities used by workflows
Anti-patterns
- Leaving placeholder guidance in place after the project conventions are known
- Documenting aspirational practices that the repo does not actually follow
- Omitting conventions that contributors need to work safely