63 lines
4.5 KiB
Markdown
63 lines
4.5 KiB
Markdown
# SQA Review Record
|
|
|
|
## Metadata
|
|
| Key | Value |
|
|
| --- | --- |
|
|
| ID | RC-010 |
|
|
| CrossReference | [MIL-001], [QC-PY-001] |
|
|
|
|
## Version History
|
|
| Date | Status | Author | Reviewer | Change | Commit |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| 2026-10-28 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [ad3334f] |
|
|
|
|
---
|
|
|
|
## Artifact Under Review
|
|
|
|
- Instance reviewed: source of milestone MIL-001 (src/cookie_clicker_bot, tests/, pyproject.toml) ([MIL-001])
|
|
- Checklist used: [QC-PY-001]
|
|
- Scope: full review
|
|
- Language and domain: n/a (technical type)
|
|
- Language reviewer: none
|
|
- Mode: autonomous, not independent (the reviewer is `AI as stand-in for S01`)
|
|
|
|
## Checklist Results
|
|
|
|
| # | Criterion | Status | Evidence/Notes |
|
|
| --- | --- | --- | --- |
|
|
| 1 | Packages, modules, functions, variables, classes and constants follow PEP 8 casing (`snake_case`, `PascalCase`, `UPPER_SNAKE`) | Pass | snake_case modules, UPPER_SNAKE constants. |
|
|
| 2 | Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes | Pass | Names state purpose (RUN_DURATION_SECONDS). |
|
|
| 3 | Code is produced by the project's formatter and passes its linter with no unexplained suppressions | Pass | `ruff check src tests` reports no findings; ruff configured in pyproject.toml. |
|
|
| 4 | Every function and method signature is type-annotated, including `-> None` | Pass | Test functions annotated with -> None; constants annotated. |
|
|
| 5 | No bare `except:`, no swallowed exceptions; specific exceptions are raised and the cause is kept (`raise ... from`) | N-A | No exception handling in this milestone. |
|
|
| 6 | No mutable default arguments and no shadowed builtins | Pass | None present. |
|
|
| 7 | Files, locks and connections are managed with context managers | N-A | No files or connections yet. |
|
|
| 8 | Public modules, classes and functions have docstrings that say what, not how | Pass | Module docstrings use Doxygen @file/@brief. |
|
|
| 9 | Logging uses `logging`, not `print`; no secrets or personal data in log output | N-A | No logging yet. |
|
|
| 10 | Classes and operations trace to the Design Class Diagram they implement; deviations are recorded | N-A | Plain technical task; no Design Class Diagram exists or is required. |
|
|
| 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 runs offline; `pytest` passes 2 tests. |
|
|
| 12 | Type checker runs in strict mode without errors; `Any` is justified in a comment | Pass | mypy strict configured; no Any. |
|
|
| 13 | Dependencies are declared and pinned in the project's dependency file, none unused | Pass | selenium>=4.25 is the only runtime dependency (ADR-0001). |
|
|
| 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 | Timing constants 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 exist; no cross 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 classes 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 and presentation under src/; unit, integration and e2e under tests/. |
|
|
| 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 English, snake_case, no spaces. |
|
|
|
|
## Overall Verdict
|
|
|
|
Go - All Mandatory criteria pass or are not applicable to this skeleton. Stand-in review, not independent.
|
|
|
|
## Action Items
|
|
|
|
| Action | Owner | Due |
|
|
| --- | --- | --- |
|
|
| None | S01 | - |
|
|
|
|
---
|
|
|
|
[MIL-001]: ../../milestones/mil-001-project-setup.md
|
|
[QC-PY-001]: ../../../framework/qc/code/qc-programming-python.md
|
|
[ad3334f]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/048-the-coockie-factory/commit/ad3334fa13c4261c3d034fbffcc7b43fe95fbb31
|