Delivers MIL-004 Documentation and release, the last phase of the plan.
README.md: what the game is, .venv set-up with python -m pip install --upgrade pip, run, test, code checks, Doxygen build, layout. The brief's README template was not supplied, so this is a draft for S01 to review.
Lint, format and typing fixes found by the source review (ruff import order and format, Final account key constants for mypy --strict, typed test helpers)
ruff and mypy configured in pyproject.toml; dev tools pinned to version ranges (runtime still has no dependencies)
MIL-004 reviewed (RC-011, Go) and Accepted; Python source reviewed against QC-PY-001 (RC-012, Go); Traceability Matrix updated
Verification
pytest: 36 passed. ruff check, ruff format --check and mypy --strict: clean. doxygen Doxyfile: no warnings, every module, class and function has @brief (@param/@return where they apply). Followed the README in a clean copy of the working tree (without .venv and .env): pip upgrade, install, tests, checks, a piped game and Doxygen all worked.
Notes
Dev extra now includes ruff and mypy (the plan named only pytest); needed for the Python checklist. Easy to drop if S01 prefers pytest only.
The clean-copy check used the uncommitted tree, not a real clone; worth repeating after merge.
Author and reviewer are both S01 (single participant); noted in the review records.
## Summary
Delivers MIL-004 Documentation and release, the last phase of the plan.
- `README.md`: what the game is, `.venv` set-up with `python -m pip install --upgrade pip`, run, test, code checks, Doxygen build, layout. The brief's README template was not supplied, so this is a draft for S01 to review.
- Lint, format and typing fixes found by the source review (ruff import order and format, `Final` account key constants for `mypy --strict`, typed test helpers)
- ruff and mypy configured in `pyproject.toml`; dev tools pinned to version ranges (runtime still has no dependencies)
- MIL-004 reviewed (RC-011, Go) and Accepted; Python source reviewed against QC-PY-001 (RC-012, Go); Traceability Matrix updated
## Verification
`pytest`: 36 passed. `ruff check`, `ruff format --check` and `mypy --strict`: clean. `doxygen Doxyfile`: no warnings, every module, class and function has `@brief` (`@param`/`@return` where they apply). Followed the README in a clean copy of the working tree (without `.venv` and `.env`): pip upgrade, install, tests, checks, a piped game and Doxygen all worked.
## Notes
- Dev extra now includes ruff and mypy (the plan named only pytest); needed for the Python checklist. Easy to drop if S01 prefers pytest only.
- The clean-copy check used the uncommitted tree, not a real clone; worth repeating after merge.
- Author and reviewer are both S01 (single participant); noted in the review records.
Closes #17
Closes #18
Closes #19
Closes #20
Describe the game, the .venv set-up with pip upgrade, running the game
and tests, the code checks, the Doxygen build and the layout. Verified
by following it in a clean copy of the tree.
Task: MIL-004#1
Task: MIL-004#4
Closes#17Closes#20
Order imports, format with ruff, make the account key constants Final
so mypy --strict accepts them, and type the test helpers. Configure
ruff and mypy in pyproject.toml and pin the dev tool versions. All
modules, classes and functions already carry Doxygen comments;
doxygen Doxyfile builds without warnings.
Task: MIL-004#2
Closes#18
Review MIL-004 (RC-011, Go) and the Python source against QC-PY-001
(RC-012, Go) and accept MIL-004. Update the Traceability Matrix.
Task: MIL-004#3
Closes#19
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Summary
Delivers MIL-004 Documentation and release, the last phase of the plan.
README.md: what the game is,.venvset-up withpython -m pip install --upgrade pip, run, test, code checks, Doxygen build, layout. The brief's README template was not supplied, so this is a draft for S01 to review.Finalaccount key constants formypy --strict, typed test helpers)pyproject.toml; dev tools pinned to version ranges (runtime still has no dependencies)Verification
pytest: 36 passed.ruff check,ruff format --checkandmypy --strict: clean.doxygen Doxyfile: no warnings, every module, class and function has@brief(@param/@returnwhere they apply). Followed the README in a clean copy of the working tree (without.venvand.env): pip upgrade, install, tests, checks, a piped game and Doxygen all worked.Notes
Closes #17
Closes #18
Closes #19
Closes #20