What problem does it solve?
Establishes and documents consistent coding rules, naming, structure, environment, and architecture conventions to reduce ambiguity and improve collaboration between human developers and AI assistants.
Core Features & Use Cases
- Naming Rules: Clear guidelines for variables, functions, files, and folders to ensure consistent identifiers across the codebase.
- Code Style & Patterns: Formatting, indentation, quote usage, semicolons, and reusable pattern examples so generated code matches project expectations.
- Structure & Architecture: Folder separation, layer responsibilities, import rules, and clean-architecture guidance to prevent coupling and improve maintainability.
- Environment & Security: Environment variable prefixes, .env file structure, and validation rules to avoid leaking secrets and standardize deployments.
- PDCA Integration & Verification: Phase-based deliverables, checklists, and verification points to validate conventions during development and code reviews.
Quick Start
Ask the agent to generate CONVENTIONS.md covering naming, code style, folder structure, environment variables, and clean architecture for this project.