32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
|
# Backend Development Guidelines
|
||
|
|
|
||
|
|
> Best practices for backend development in this project.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
This directory captures backend conventions observed from the current repository (not aspirational rules).
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Guidelines Index
|
||
|
|
|
||
|
|
| Guide | Description | Status |
|
||
|
|
|-------|-------------|--------|
|
||
|
|
| [Directory Structure](./directory-structure.md) | Module organization and file layout | Completed |
|
||
|
|
| [Database Guidelines](./database-guidelines.md) | ORM patterns, queries, migrations | Completed |
|
||
|
|
| [Error Handling](./error-handling.md) | Error types, handling strategies | Completed |
|
||
|
|
| [Quality Guidelines](./quality-guidelines.md) | Code standards, forbidden patterns | Completed |
|
||
|
|
| [Logging Guidelines](./logging-guidelines.md) | Structured logging, log levels | Completed |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Maintenance Notes
|
||
|
|
|
||
|
|
When behavior changes, update the corresponding guideline file in the same task/PR:
|
||
|
|
|
||
|
|
1. Keep statements grounded in repository evidence (code/config/tests/docs)
|
||
|
|
2. Add or refresh concrete file-path examples
|
||
|
|
3. Keep anti-patterns tied to existing rules or existing legacy code evidence
|