Tirsvad-Udemy-100-days-of-code/015-coffee-machine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add SQA review records and plan MIL-004 Code Review and CI

Browse Source 
Add RC-001 to RC-005 for the Business Case, Stakeholder Analysis and
MIL-001 to MIL-003, checked against their QC checklists, and a
traceability matrix. The reviews found a missing duration constraint in
the Business Case; BC-001 v2 adds it, and SA-001 v2 records the
sign-off. Register RC and TM in the artifact registry.

Plan MIL-004 (review the source against QC-PY-001, add a CI workflow)
as Proposed, with Business Case objective 6, a Project Plan gateway
row and a matrix entry. The milestone is not yet synced to the git host.

No issue closed: planning and review documents only, no code changed.
This commit is contained in:
Tirsvad
2026-10-06 20:42:51 +08:00
parent 1403dacf0e
commit 8ef00aafaa
11 changed files with 419 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/business-case.md
+5 -2
View File
@@ -9,7 +9,8 @@
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-05 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | [c0c3940] |
| 2026-10-06 | Accepted | Jens Tirsvad Nielsen | S01 | Added duration constraint (RC-001 action) | pending |
| 2026-10-06 | Proposed | Jens Tirsvad Nielsen | S01 | Added objective 6 and scope for code review and CI | pending |
---
@@ -45,6 +46,7 @@ participants and for viewers browsing the repository.
3. Cover the behaviour with automated pytest tests.
4. Document how to set up a local `.venv` and run the program and tests.
5. Publish the repository with a description, topics and README.
6. Review the source code against the Python quality checklist and run the tests and code checks automatically on every push.
## Scope
@@ -55,6 +57,7 @@ participants and for viewers browsing the repository.
- `pyproject.toml`, Python `.gitignore`, `Doxyfile`, `README.md`.
- Project documents under `docs/`.
- Repository description and topics on the git host.
- A review record for the source code and a CI workflow (MIL-004).
### Out of Scope
@@ -109,6 +112,7 @@ professional project hygiene, and the goal of sharing readable solutions.
- Constants live in `constants.py`.
- Source files use Doxygen comments.
- Nothing is committed or pushed unless the user asks.
- Duration: one week, 2026-10-05 to 2026-10-12.
## Cost–Benefit Assessment
@@ -131,4 +135,3 @@ Proceed — the scope is small, well specified and delivers a reusable example.
---
[SA-001]: ./stakeholder-analysis.md
[c0c3940]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/commit/c0c3940551db0d7d96492cc734976d0436051ff9