| 1 |
Packages, modules, functions, variables, classes and constants follow PEP 8 casing (snake_case, PascalCase, UPPER_SNAKE) |
Pass |
Modules, classes and functions use snake_case and PascalCase; ruff rule set N passes on src, tests and tools. |
| 2 |
Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes |
Pass |
Names state purpose (FlashCardView, language_text_id, generate_images). |
| 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 signature is annotated; mypy --strict passes on 13 source files and on tools/generate_images.py. |
| 5 |
No bare except:, no swallowed exceptions; specific exceptions are raised and the cause is kept (raise ... from) |
Pass |
The only except is tk.TclError in the e2e fixture, used to skip when no display exists; none is bare or swallowed silently. |
| 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 |
Pass |
Files are written with Path.write_bytes; the Tk root is destroyed in the fixture teardown. |
| 8 |
Public modules, classes and functions have docstrings that say what, not how |
Pass |
Public modules, classes and functions have Doxygen docstrings; doxygen Doxyfile ends with 0 warnings. |
| 9 |
Logging uses logging, not print; no secrets or personal data in log output |
Pass |
No print; no logging is needed in a view. |
| 10 |
Classes and operations trace to the Design Class Diagram they implement; deviations are recorded |
Pass |
FlashCardView and FlashCardViewModel are classes of DCD-001 with the names and responsibilities given there; create_application is the composition root app.main of DCD-001. |
| 11 |
Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network |
Pass |
18 tests: view model, image generator, application entry, and 5 e2e tests of the real window (not skipped on this machine); none uses the network. |
| 12 |
Type checker runs in strict mode without errors; Any is justified in a comment |
Pass |
mypy --strict reports no issue; no Any. |
| 13 |
Dependencies are declared and pinned in the project's dependency file, none unused |
Pass |
dependencies stays empty; the tool uses the standard library only. |
| 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 |
Colours, sizes, fonts and file names come from constants.py once; the image generator reads sizes from it. |
| 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 Layers point inward kept; the view model imports no Tkinter. |
| 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 |
The view only builds widgets; the texts come from the view model (single responsibility); nothing is switched on type. |
| 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 |
presentation/features/flash_card/ holds view and view model as the clean-architecture skill's default layout; tests are in unit and e2e. |
| 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 snake_case; no space. |
