From 71a27ddc1f5555c1b836b1556fab292ebc9deb62 Mon Sep 17 00:00:00 2001 From: Jens Tirsvad Nielsen Date: Tue, 6 Oct 2026 21:44:02 +0800 Subject: [PATCH] Re-review the Business Case and accept v4 Add RC-008 for the Business Case after v3 added objective 6. Two defects found: objective 6 had no success criterion, and the Python version was worded differently in the assumption and the constraint. BC-001 v4 fixes both and is accepted; v3 is deprecated. The traceability matrix now points to RC-008. No issue closed: review and documentation only, no code changed. --- docs/artifact-registry.md | 2 +- docs/business-case.md | 7 ++++--- docs/sqa/traceability-matrix.md | 7 +++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/artifact-registry.md b/docs/artifact-registry.md index a5e3564..856092f 100644 --- a/docs/artifact-registry.md +++ b/docs/artifact-registry.md @@ -15,7 +15,7 @@ document of a type. `Primary File` may contain a glob (e.g. | SA | Stakeholder Analysis | docs/stakeholder-analysis.md | 002 | | PP | Project Plan | docs/project-plan.md | 002 | | MIL | Milestone / Gateway | docs/milestones/*.md | 005 | -| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 008 | +| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 009 | | TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 | ## Languages diff --git a/docs/business-case.md b/docs/business-case.md index 92cf811..816857c 100644 --- a/docs/business-case.md +++ b/docs/business-case.md @@ -9,8 +9,8 @@ ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-10-06 | Accepted | Jens Tirsvad Nielsen | S01 | Added duration constraint (RC-001 action) | [8ef00aa] | -| 2026-10-06 | Proposed | Jens Tirsvad Nielsen | S01 | Added objective 6 and scope for code review and CI | [8ef00aa] | +| 2026-10-06 | Deprecated | Jens Tirsvad Nielsen | S01 | Added objective 6 and scope for code review and CI | [8ef00aa] | +| 2026-10-06 | Accepted | Jens Tirsvad Nielsen | S01 | Added success criterion 6 and clarified the Python version (RC-008 actions) | pending | --- @@ -92,6 +92,7 @@ professional project hygiene, and the goal of sharing readable solutions. | 3 | Runtime dependencies | 0 | `pyproject.toml` `dependencies` is empty | | 4 | Setup documented | A new reader can run program and tests from README | README walkthrough | | 5 | Repository metadata | Description and at least 3 topics set | Repository page | +| 6 | Code reviewed and checked automatically | Source review record with verdict Go; latest CI run on `main` green | `docs/sqa/reviews/` and the CI run on the git host | ## Risks @@ -108,7 +109,7 @@ professional project hygiene, and the goal of sharing readable solutions. ## Constraints -- Python greater than 3.13 as requested, `venv` for environments, pytest for tests. +- Python 3.13 or newer (the request says "greater than 3.13"; read as `>=3.13`), `venv` for environments, pytest for tests. - Constants live in `constants.py`. - Source files use Doxygen comments. - Nothing is committed or pushed unless the user asks. diff --git a/docs/sqa/traceability-matrix.md b/docs/sqa/traceability-matrix.md index 3f1c651..2e73c3f 100644 --- a/docs/sqa/traceability-matrix.md +++ b/docs/sqa/traceability-matrix.md @@ -9,8 +9,8 @@ ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-10-06 | Proposed | Jens Tirsvad Nielsen | S01 | Added MIL-004 | [8ef00aa] | | 2026-10-06 | Proposed | Jens Tirsvad Nielsen | S01 | Added RC-006, RC-007 and the source code row | [00d47e2] | +| 2026-10-06 | Proposed | Jens Tirsvad Nielsen | S01 | Business Case last reviewed in RC-008 | pending | --- @@ -25,7 +25,7 @@ artifact instance is created or reviewed. | Artifact Instance | Type | Upstream (Backward Link) | Downstream (Forward Link) | Last Reviewed (RC-ID) | | --- | --- | --- | --- | --- | | [SA-001] | Stakeholder Analysis | - | [BC-001] | [RC-002] | -| [BC-001] | Business Case | [SA-001] | [PP-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004] | [RC-001] | +| [BC-001] | Business Case | [SA-001] | [PP-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004] | [RC-008] | | [PP-001] | Project Plan | [BC-001], [SA-001] | [MIL-001], [MIL-002], [MIL-003], [MIL-004] | - | | [MIL-001] | Milestone | [BC-001], [PP-001] | - | [RC-003] | | [MIL-002] | Milestone | [BC-001], [PP-001] | - | [RC-004] | @@ -48,12 +48,11 @@ artifact instance is created or reviewed. [MIL-002]: ../milestones/mil-002-coffee-machine-core.md [MIL-003]: ../milestones/mil-003-quality-and-publication.md [MIL-004]: ../milestones/mil-004-code-review-and-ci.md -[RC-001]: ./reviews/rc-001-business-case.md [RC-002]: ./reviews/rc-002-stakeholder-analysis.md [RC-003]: ./reviews/rc-003-mil-001.md [RC-004]: ./reviews/rc-004-mil-002.md [RC-005]: ./reviews/rc-005-mil-003.md [RC-006]: ./reviews/rc-006-source-code.md [RC-007]: ./reviews/rc-007-mil-004.md -[8ef00aa]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/commit/8ef00aafaaa193ea565f1a45238d31e963a5e05d +[RC-008]: ./reviews/rc-008-business-case-v3.md [00d47e2]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/commit/00d47e244c82007bbc55e18312649189b175ec10