1.7 KiB
1.7 KiB
AGENTS.md (root)
Precedence: The closest AGENTS.md to changed files wins. Root holds global defaults only.
Project Overview
{{PROJECT_DESCRIPTION}}
Tech Stack: {{LANGUAGE}} {{VERSION}}, {{BUILD_TOOL}}, {{FRAMEWORK}} Type: {{PROJECT_TYPE}}
Global Rules
- Keep PRs small (~≤300 net LOC)
- Conventional Commits:
type(scope): subject - Ask before: heavy deps, full e2e, repo rewrites
- Never commit secrets or PII {{LANGUAGE_CONVENTIONS}}
Development Workflow
- Create feature branch:
git checkout -b feature/description - Make changes with tests
- Run pre-commit checks (see below)
- Commit with conventional format
- Push and create PR
- Address review feedback
- Merge when approved
Pre-commit Checks
Always run before committing:
- Typecheck: {{TYPECHECK_CMD}}
- Lint: {{LINT_CMD}}
- Format: {{FORMAT_CMD}}
- Tests: {{TEST_CMD}}
- Build: {{BUILD_CMD}}
Code Quality Standards
{{QUALITY_STANDARDS}}
Security & Safety
- Never commit secrets, credentials, or PII
- Validate all user inputs
- Use parameterized queries for database access
- Keep dependencies updated {{SECURITY_SPECIFIC}}
Testing Requirements
- Write tests for new features
- Maintain {{TEST_COVERAGE}}% minimum coverage
- Run fast tests locally: {{TEST_FAST_CMD}}
- Run full suite in CI: {{TEST_FULL_CMD}}
Index of Scoped AGENTS.md
{{SCOPE_INDEX}}
When Instructions Conflict
Nearest AGENTS.md wins. User prompts override files. {{LANGUAGE_SPECIFIC_CONFLICT_RESOLUTION}}
Documentation
- Architecture: {{ARCHITECTURE_DOC}}
- API docs: {{API_DOC}}
- Contributing: {{CONTRIBUTING_DOC}}