| 1 |
Packages, modules, functions, variables, classes and constants follow PEP 8 casing (snake_case, PascalCase, UPPER_SNAKE) |
Pass |
Modules, functions and variables are snake_case, classes PascalCase, constants UPPER_SNAKE; ruff check with the N rules passes. |
| 2 |
Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes |
Pass |
Names state purpose (for example retry, login, book_class, get_my_bookings); no single-letter names outside comprehensions. |
| 3 |
Code is produced by the project's formatter and passes its linter with no unexplained suppressions |
Pass |
ruff format leaves 0 files changed and ruff check reports 0 findings; there is no suppression. |
| 4 |
Every function and method signature is type-annotated, including -> None |
Pass |
Every function and method has annotations (ruff ANN rules pass), including -> None. |
| 5 |
No bare except:, no swallowed exceptions; specific exceptions are raised and the cause is kept (raise ... from) |
Pass |
No bare except; specific exceptions are caught, and re-raised with raise ... from where the cause matters. |
| 6 |
No mutable default arguments and no shadowed builtins |
Pass |
No mutable default arguments; no builtin is shadowed (ruff B and A-style checks pass). |
| 7 |
Files, locks and connections are managed with context managers |
Pass |
Files and the browser are managed with with/try-finally; no unmanaged file handle exists. |
| 8 |
Public modules, classes and functions have docstrings that say what, not how |
Pass |
Public modules, classes and functions have Doxygen docstrings (@brief, @param, @return). |
| 9 |
Logging uses logging, not print; no secrets or personal data in log output |
Pass |
No print calls; messages go through logging. |
| 10 |
Classes and operations trace to the Design Class Diagram they implement; deviations are recorded |
N-A |
No Design Class Diagram exists; ADR-0001 records that design artifacts are skipped. Classes follow ADR-0002. |
| 11 |
Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network |
Pass |
103 unit tests (models, parsing, decisions, booking, recorder, command line) need no browser or network; 9 container tests run the adapter against local HTML fixtures; coverage of the non-infrastructure modules is 100%. |
| 12 |
Type checker runs in strict mode without errors; Any is justified in a comment |
N-A |
No strict type checker is configured; annotations are complete and checked by ruff. |
| 13 |
Dependencies are declared and pinned in the project's dependency file, none unused |
Pass |
pyproject.toml declares Selenium (runtime) and pytest, pytest-cov, ruff (dev) with lower bounds; none is unused. |
| 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 |
Each rule, constant and message exists once (constants in constants.py, rules in domain/). |
| 15 |
Imports point inward: business-rule modules import no framework, database, UI or delivery-mechanism code, and there are no import cycles |
Pass |
domain and application import no Selenium; only infrastructure imports it; no import cycle exists. |
| 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 |
One reason to change per module; the adapter hides Selenium behind a port; fakes honour the port contract. |
| 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 |
Layout follows src/snack_and_lift/{domain,application,infrastructure} and tests/{unit,integration,e2e}; there is no presentation layer for a command-line bot (ADR-0002). |
| 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 file and folder names are English lowercase with _, - and . only. |
