Skip to content

Documentation & Conventions

  • API Contracts: Maintain clear OpenAPI/Swagger specifications for APIs. AI uses these to generate clients and validate requests/responses.
  • Consistent Naming: Use predictable names for variables, functions, classes, files, and modules.
  • Code Formatting: Enforce a strict formatter (Prettier, Black, etc.) so AI-generated code matches the project style.
  • JSDoc/Docstrings: Add comments explaining complex logic or business rules. AI can often leverage these for better understanding.
  • READMEs: Document module/feature responsibilities in README files within feature directories.

Built with VitePress