template/templates/CONVENTIONS.template.md

{{PROJECT_NAME}} Conventions

Naming

• {{NAMING_RULE}}

File Organization

• {{FILE_ORGANIZATION_RULE}}

Folder Organization

• {{FOLDER_ORGANIZATION_RULE}}

Dependency Injection

• {{DEPENDENCY_INJECTION_RULE}}

Logging

• {{LOGGING_RULE}}

Validation

• {{VALIDATION_RULE}}

Error Handling

• {{ERROR_HANDLING_RULE}}

DTO Rules

• {{DTO_RULE}}

Repository Rules

• Use the repository pattern for persistence boundaries.
• Repository interfaces live in {{REPOSITORY_INTERFACE_LOCATION}}.
• Repository implementations live in {{REPOSITORY_IMPLEMENTATION_LOCATION}}.
• Repositories should be domain-specific, not generic CRUD wrappers by default.
• {{REPOSITORY_RULE}}

Service Rules

• {{SERVICE_RULE}}

Testing

• Unit tests: {{UNIT_TEST_RULE}}
• Integration tests: {{INTEGRATION_TEST_RULE}}
• End-to-end tests: {{E2E_TEST_RULE}}

Git Workflow

• Branch naming: {{BRANCH_NAMING}}
• Merge policy: {{MERGE_POLICY}}
• Commit style: {{COMMIT_STYLE}}

Pull Requests

• {{PULL_REQUEST_RULE}}

Code Reviews

• {{CODE_REVIEW_RULE}}