<relative/path/to/file>.py¶
| Item | Value |
|---|---|
| Layer | Core / Models / Repositories / Services / API / Middleware / Utils |
| Responsibility | Short mission statement (1–2 sentences) |
| Status | 🔴 TODO / 🟡 WIP / 🟢 Done |
1. Purpose¶
Describe why this file exists and the problem it solves.
2. Public API¶
List classes, functions, constants that other modules may import.
| Symbol | Type | Description |
|---|---|---|
FooService | class | Business logic for Foo |
BAR_REGEX | constant | Validates … |
3. Behaviour & Edge-Cases¶
Bullet-point any non-obvious logic, edge-cases, race-conditions, etc.
4. Dependencies¶
Internal modules or external libraries this file relies on.
5. Tests¶
Reference test files & coverage notes.
| Test file | Scenario |
|---|---|
tests/services/test_foo.py | happy-path create / read |
6. Open TODOs¶
- Item 1
- Item 2
Update this page whenever the implementation changes.