docs: track project rules (AGENTS.md) + accent-swappable UI note
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,68 @@
|
||||
\# 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.
|
||||
|
||||
Reference in New Issue
Block a user