{{PROJECT_NAME}}
AI agent configuration following the AGENTS.md standard
Project Overview
{{PROJECT_DESCRIPTION}}
Tech Stack: {{TECH_STACK}} Language: {{PRIMARY_LANGUAGE}}
Commands
Build
{{BUILD_COMMAND}}
Test
{{TEST_COMMAND}}
Lint
{{LINT_COMMAND}}
Run Development
{{DEV_COMMAND}}
Testing
- Framework: {{TEST_FRAMEWORK}}
- Coverage Tool: {{COVERAGE_TOOL}}
- Minimum Coverage: {{MIN_COVERAGE}}%
Test Conventions
- Test files MUST be placed in
{{TEST_DIRECTORY}} - Test files MUST follow pattern
{{TEST_FILE_PATTERN}} - Tests SHOULD be written before implementation (TDD)
Project Structure
{{PROJECT_NAME}}/
{{PROJECT_STRUCTURE}}
Key Files
- Entry point:
{{ENTRY_POINT}} - Config:
{{CONFIG_FILE}} - Types:
{{TYPES_FILE}}
Code Style
Formatting
- Formatter: {{FORMATTER}}
- Line Length: {{LINE_LENGTH}}
- Indentation: {{INDENT_STYLE}} ({{INDENT_SIZE}} spaces)
Naming Conventions
- Files: {{FILE_NAMING}} (e.g.,
kebab-case.ts) - Variables: {{VAR_NAMING}} (e.g.,
camelCase) - Classes: {{CLASS_NAMING}} (e.g.,
PascalCase) - Constants: {{CONST_NAMING}} (e.g.,
SCREAMING_SNAKE_CASE)
Code Patterns
{{CODE_PATTERNS}}
Git Workflow
Branch Naming
- Features:
feature/{{FEATURE_BRANCH_PATTERN}} - Bug fixes:
fix/{{FIX_BRANCH_PATTERN}} - Releases:
release/{{RELEASE_BRANCH_PATTERN}}
Commit Messages
Agents MUST follow this commit format:
{{COMMIT_FORMAT}}
Example:
{{COMMIT_EXAMPLE}}
Pull Requests
- PRs MUST have passing CI
- PRs SHOULD have at least {{MIN_REVIEWERS}} reviewer(s)
- PRs MUST NOT be merged with failing tests
Boundaries
DO NOT Modify
Agents MUST NOT modify these files/directories without explicit approval: {{DO_NOT_MODIFY}}
DO NOT Create
Agents MUST NOT create: {{DO_NOT_CREATE}}
Security Sensitive
These files contain sensitive data - agents MUST NOT expose or commit: {{SECURITY_SENSITIVE}}
Context Files
For additional context, agents SHOULD read: {{CONTEXT_FILES}}
Dependencies
Adding Dependencies
- Runtime dependencies MUST be approved before adding
- Dev dependencies MAY be added for tooling
- Native dependencies MUST NOT be added (use platform APIs)
Forbidden Packages
{{FORBIDDEN_PACKAGES}}
Generated by AetherLight Spec: AGENTS.md | RFC 2119 Keywords