| 1 |
Packages, modules, functions, variables, classes and constants follow PEP 8 casing (snake_case, PascalCase, UPPER_SNAKE) |
Pass |
Constants are UPPER_SNAKE, package names snake_case. |
| 2 |
Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes |
Pass |
Names state purpose (REQUEST_TIMEOUT_SECONDS, SELECTOR_ROW). |
| 3 |
Code is produced by the project's formatter and passes its linter with no unexplained suppressions |
Pass |
ruff format and ruff check (configured in pyproject.toml) report no finding. |
| 4 |
Every function and method signature is type-annotated, including -> None |
N-A |
The scaffold defines no function; constants carry Final annotations. |
| 5 |
No bare except:, no swallowed exceptions; specific exceptions are raised and the cause is kept (raise ... from) |
N-A |
No logic exists in the scaffold; nothing to check yet. |
| 6 |
No mutable default arguments and no shadowed builtins |
N-A |
No logic exists in the scaffold; nothing to check yet. |
| 7 |
Files, locks and connections are managed with context managers |
N-A |
No logic exists in the scaffold; nothing to check yet. |
| 8 |
Public modules, classes and functions have docstrings that say what, not how |
Pass |
Modules and constant groups have Doxygen comments; doxygen Doxyfile has 0 warnings. |
| 9 |
Logging uses logging, not print; no secrets or personal data in log output |
N-A |
No logic exists in the scaffold; nothing to check yet. |
| 10 |
Classes and operations trace to the Design Class Diagram they implement; deviations are recorded |
N-A |
No logic exists in the scaffold; nothing to check yet. |
| 11 |
Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network |
Pass |
tests/unit/test_smoke.py checks the constants and runs without the network. |
| 12 |
Type checker runs in strict mode without errors; Any is justified in a comment |
N-A |
No logic exists in the scaffold; nothing to check yet. |
| 13 |
Dependencies are declared and pinned in the project's dependency file, none unused |
Pass |
Three runtime dependencies and the dev extra are declared with lower bounds; none unused yet (they are used from MIL-003). |
| 14 |
Each piece of knowledge (a business rule, constant, format, validation or query) is defined in one place; code is merged only where it expresses the same knowledge, not where it merely looks alike |
Pass |
Every constant is defined once in constants.py. |
| 15 |
Imports point inward: business-rule modules import no framework, database, UI or delivery-mechanism code, and there are no import cycles |
Pass |
Layer packages are empty; no imports yet. |
| 16 |
SOLID holds: a class or module has one reason to change; new behaviour is added by extension, not by editing a type test in several places; subclasses honour the contract of their base; protocols are narrow; high-level code depends on protocols or abstract types and receives its implementations |
N-A |
No logic exists in the scaffold; nothing to check yet. |
| 17 |
Source is laid out in the layers and folders of the clean architecture folder structure (domain, application, infrastructure, presentation packages under src/, and unit, integration and e2e under tests/), in snake_case, and imports between the layers point inward |
Pass |
src/musical_time_machine/{domain,application,infrastructure,presentation} and tests/unit exist. |
| 18 |
File and folder names are English, contain no space and no character outside letters, digits, -, _ and ., and follow the casing of the language for files |
Pass |
All names are English, lowercase with underscores. |
