Skip to content

Coding Conventions: {project_name}

Source: conventions.md

markdown
# Coding Conventions: {project_name}

> **Version:** 1
> **Status:** Draft
> **Last Updated:** {date}
> **Author:** Ingestion Team — Convention Miner
> **Source:** Extracted from codebase analysis
> **Change Log:**
> - v1 ({date}): Initial version

## Naming Conventions
<!-- sniper:managed:naming:start -->
<!-- Variable naming (camelCase/snake_case), file naming, directory naming, exported symbols -->
<!-- Include code examples from the actual codebase -->
<!-- sniper:managed:naming:end -->

## Code Organization
<!-- sniper:managed:code-org:start -->
<!-- How files are structured within directories, barrel exports, index files, feature-based vs layer-based -->
<!-- sniper:managed:code-org:end -->

## Error Handling Patterns
<!-- sniper:managed:error-handling:start -->
<!-- Custom error classes, error codes, error boundaries, try/catch patterns -->
<!-- Include code examples -->
<!-- sniper:managed:error-handling:end -->

## Testing Patterns
<!-- sniper:managed:testing:start -->
<!-- Test file location, test naming, mock patterns, fixtures, test utilities -->
<!-- Include code examples -->
<!-- sniper:managed:testing:end -->

## API Patterns
<!-- sniper:managed:api-patterns:start -->
<!-- Request validation, response formatting, middleware usage, auth checks -->
<!-- Include code examples -->
<!-- sniper:managed:api-patterns:end -->

## Import & Module Patterns
<!-- sniper:managed:imports:start -->
<!-- Absolute vs relative imports, import ordering, path aliases -->
<!-- Include code examples -->
<!-- sniper:managed:imports:end -->

## Configuration & Environment
<!-- sniper:managed:config:start -->
<!-- How env vars are accessed, config files, validation -->
<!-- Include code examples -->
<!-- sniper:managed:config:end -->

## Logging
<!-- sniper:managed:logging:start -->
<!-- Logging library, log levels, structured logging patterns -->
<!-- Include code examples -->
<!-- sniper:managed:logging:end -->

## Additional Conventions
<!-- Add project-specific conventions not covered above -->