| 1 |
Packages, modules, functions, variables, classes and constants follow PEP 8 casing (snake_case, PascalCase, UPPER_SNAKE) |
Pass |
Modules, functions and constants use snake_case and UPPER_SNAKE; ruff rule set N passes. |
| 2 |
Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes |
Pass |
Names state purpose (FLIP_DELAY_MS, DEFAULT_DATA_DIR); no abbreviations. |
| 3 |
Code is produced by the project's formatter and passes its linter with no unexplained suppressions |
Pass |
ruff check and ruff format --check pass with no suppressions. |
| 4 |
Every function and method signature is type-annotated, including -> None |
Pass |
Every function has annotated parameters and return type; mypy --strict passes on 9 files. |
| 5 |
No bare except:, no swallowed exceptions; specific exceptions are raised and the cause is kept (raise ... from) |
Pass |
No exception handling exists yet; no bare except. |
| 6 |
No mutable default arguments and no shadowed builtins |
Pass |
No mutable defaults, no builtin shadowed. |
| 7 |
Files, locks and connections are managed with context managers |
N-A |
No file or connection is opened yet. |
| 8 |
Public modules, classes and functions have docstrings that say what, not how |
Pass |
Every module and function has a Doxygen docstring with @file/@brief/@param/@return; doxygen Doxyfile ends with no warning. |
| 9 |
Logging uses logging, not print; no secrets or personal data in log output |
Pass |
No print; no logging needed yet. |
| 10 |
Classes and operations trace to the Design Class Diagram they implement; deviations are recorded |
Pass |
app.main and app.run are the app.main of DCD-001; constants have no design class. |
| 11 |
Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network |
Pass |
tests/unit/test_constants.py and test_app.py (7 tests) name the behaviour and use no network. |
| 12 |
Type checker runs in strict mode without errors; Any is justified in a comment |
Pass |
mypy --strict reports no issue; no Any is used. |
| 13 |
Dependencies are declared and pinned in the project's dependency file, none unused |
Pass |
dependencies is empty; extras are declared in pyproject.toml with version ranges, and playsound is pinned. |
| 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 |
lint-imports reports the contract Layers point inward kept. |
| 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 |
Pass |
Modules are small and single-purpose; nothing to extend 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 |
domain, application, infrastructure, presentation packages exist under src/flash_card/, and tests/unit, integration, e2e 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 |
File and folder names are English lower snake_case with no space. |
