cesnimda
69 lines
742 B
Markdown
69 lines
742 B
Markdown
\# Project Rules
|
|
|
|
|
|
|
|
\## Code Quality
|
|
|
|
|
|
|
|
\- Prefer readability over cleverness.
|
|
|
|
\- Keep methods under \~40 lines where practical.
|
|
|
|
\- Avoid duplicated logic.
|
|
|
|
\- Follow SOLID principles.
|
|
|
|
\- Keep files focused on a single responsibility.
|
|
|
|
|
|
|
|
\## Safety
|
|
|
|
|
|
|
|
\- Never commit secrets.
|
|
|
|
\- Never disable tests to make them pass.
|
|
|
|
\- Never remove functionality without explaining why.
|
|
|
|
|
|
|
|
\## Testing
|
|
|
|
|
|
|
|
Every change must include:
|
|
|
|
\- Unit tests where appropriate.
|
|
|
|
\- Integration tests for API changes.
|
|
|
|
\- Build verification.
|
|
|
|
|
|
|
|
\## Architecture
|
|
|
|
|
|
|
|
Prefer:
|
|
|
|
\- Dependency Injection
|
|
|
|
\- Composition over inheritance
|
|
|
|
\- Async APIs
|
|
|
|
\- Immutable models where practical
|
|
|
|
|
|
|
|
\## Documentation
|
|
|
|
|
|
|
|
Update documentation whenever public behaviour changes.
|
|
|