Plan project and set up Phase 1 skeleton (MIL-001) #16

2026-10-07T04:45:27+02:00

Tirsvad commented

2026-10-07 04:45:27 +02:00

Summary

Adds the SQA/QC framework as a submodule.
Adds the accepted planning documents: Business Case (BC-001), Stakeholder Analysis (SA-001), Project Plan (PP-001), milestones MIL-001 to MIL-003, review records RC-001 to RC-006 and the traceability matrix.
Implements Phase 1 (MIL-001): pyproject.toml (Python >=3.13, no runtime dependencies), src/coffee_machine/constants.py, a constants consistency test, Doxyfile and a CI workflow (ruff, mypy, pytest).

Verification

ruff, mypy --strict and pytest (3 tests) pass in a fresh .venv.
doxygen Doxyfile builds without errors.
sync-project.sh --apply created 3 Milestones and 15 Issues.

Notes for the reviewer

The coffee-machine script entry point in pyproject.toml points to coffee_machine.main:main, which arrives in Phase 2.
Code review against qc-programming-python is issue #11 (Phase 2).

Closes #1
Closes #2
Closes #3
Closes #4
Closes #5

## Summary - Adds the SQA/QC framework as a submodule. - Adds the accepted planning documents: Business Case (BC-001), Stakeholder Analysis (SA-001), Project Plan (PP-001), milestones MIL-001 to MIL-003, review records RC-001 to RC-006 and the traceability matrix. - Implements Phase 1 (MIL-001): pyproject.toml (Python >=3.13, no runtime dependencies), src/coffee_machine/constants.py, a constants consistency test, Doxyfile and a CI workflow (ruff, mypy, pytest). ## Verification - ruff, mypy --strict and pytest (3 tests) pass in a fresh .venv. - doxygen Doxyfile builds without errors. - sync-project.sh --apply created 3 Milestones and 15 Issues. ## Notes for the reviewer - The coffee-machine script entry point in pyproject.toml points to coffee_machine.main:main, which arrives in Phase 2. - Code review against qc-programming-python is issue #11 (Phase 2). Closes #1 Closes #2 Closes #3 Closes #4 Closes #5

Tirsvad added 2 commits 2026-10-07 04:45:28 +02:00

Plan project and set up Phase 1 skeleton

CI / test (push) Successful in 54s

Details

c24f41207f

Add the framework submodule and the accepted planning documents:
Business Case, Stakeholder Analysis, Project Plan, three milestones,
review records RC-001 to RC-006 and the traceability matrix.

Set up the project skeleton for MIL-001: pyproject.toml (Python
>=3.13, no runtime dependencies, pytest/ruff/mypy as dev extra),
 src/coffee_machine/constants.py, a constants consistency test,
 Doxyfile and a CI workflow that runs ruff, mypy and pytest.

Task: MIL-001#1
Task: MIL-001#2
Task: MIL-001#3
Task: MIL-001#4
Task: MIL-001#5
Closes #1
Closes #2
Closes #3
Closes #4
Closes #5

Resolve pending commit links and add framework submodule

CI / test (push) Successful in 46s

Details

CI / test (pull_request) Successful in 46s

Details

28ec0e85d8

Replace `pending` in the Version History of the planning documents and
review records with the link to commit c24f412, and add the framework
gitlink that was missing from that commit.

Refs #1
Refs #2
Refs #3
Refs #4
Refs #5

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>