Tirsvad-Udemy-100-days-of-code/016-oop-coffee-machine

Files

T

CI / test (push) Successful in 54s

Details

Plan project and set up Phase 1 skeleton

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

2026-10-07 10:43:22 +08:00

2.8 KiB

Raw Blame History

Phase 3: Documentation and Publication

Metadata

Key	Value
ID	MIL-003
CrossReference	BC-001, SA-001, PP-001
Language	en
Domain	it

Version History

Date	Status	Author	Reviewer	Change	Commit
2026-10-07	Deprecated	Jens Tirsvad Nielsen	S01	Initial version	pending
2026-10-07	Accepted	Jens Tirsvad Nielsen	S01	Accepted after RC-005 (Go)	pending

Purpose

Decide whether the repository is documented and presentable for S02 and S03.

Deliverable

README following the course template, generated Doxygen documentation steps, and a repository description and topics on the git host.

Go / No-Go Criteria

#	Criterion (objectively checkable)	Go	No-Go
1	README has all template sections and the Windows, Debian and macOS venv steps including `python -m pip install --upgrade pip`	Met	Not met
2	Following the README on a clean clone runs the program and the tests	Met	Not met
3	`doxygen Doxyfile` produces documentation from the source comments	Met	Not met
4	Repository description and at least 3 topics are set on the git host	Met	Not met
5	README and LICENSE agree on the licence	Met	Not met

Dependencies

Depends on	Reason
MIL-002	Documents the finished program

Traceability

Business Case objective / KPI / user story	Reference
Objectives 3 and 4; success criteria 3 and 5	BC-001

Ownership

Role	Stakeholder ID (SA)
Owner	S01
Approving reviewer	S01

Target Date

2026-10-16 — after Phase 2.

Tasks

#	Task	Summary	Needs its own Use Case/User Story?
1	Write README	Write `README.md` from the course template: requirements, set-up for Windows PowerShell, Debian and macOS using a local `.venv` and `python -m pip install --upgrade pip`, run, test, CI, Doxygen build, project layout and licence.	No
2	Verify Doxygen build	Run Doxygen on a clean clone and check that classes and methods from the Doxygen comments appear in the output.	No
3	Set repository description and topics	Set a short description and topics on the git host repository (`Tirsvad-Udemy-100_days_of_code`) through its API using the token from `.env`, which stays personal and is never read by the project code. Needs the Product Owner's go-ahead because it changes the remote.	No
4	Verify setup from a clean clone	Follow the README from a fresh clone on the Product Owner's machine and fix any step that does not work.	No

2.8 KiB Raw Blame History