Tirsvad
00d47e244c
CI / checks (push) Successful in 1m5s
Add RC-006 (source code against QC-PY-001) and RC-007 (MIL-004), and update the traceability matrix. Set lower bounds for the dev dependencies, the one optional Fail in RC-006. Add a Gitea Actions workflow running pytest, ruff and mypy, and describe it in the README. Accept MIL-004 and link its Milestone in the Project Plan. Closes #24 Closes #25 Closes #26 Closes #27 Closes #28 Task: MIL-004#1 Task: MIL-004#2 Task: MIL-004#3 Task: MIL-004#4 Task: MIL-004#5
98 lines
4.1 KiB
Markdown
98 lines
4.1 KiB
Markdown
# Project Plan
|
|
|
|
## Metadata
|
|
| Key | Value |
|
|
| --- | --- |
|
|
| ID | PP-001 |
|
|
| CrossReference | [BC-001], [SA-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004] |
|
|
|
|
## Version History
|
|
| Date | Status | Author | Reviewer | Change | Commit |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| 2026-10-05 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | [c0c3940] |
|
|
| 2026-10-06 | Proposed | Jens Tirsvad Nielsen | S01 | Added MIL-004 Code Review and CI | [8ef00aa] |
|
|
|
|
---
|
|
|
|
## Purpose
|
|
|
|
Schedule the three phases that take the coffee machine from empty repository to
|
|
published project, within the short assignment timeline in [BC-001].
|
|
|
|
## Planning Assumptions
|
|
|
|
- Week 1 starts 2026-10-05; the plan ends by 2026-10-12.
|
|
- Phase length: two to three days; S01 reviews each phase through a pull request (see [SA-001]).
|
|
- Each phase is one branch and one pull request.
|
|
|
|
## Gateway Schedule
|
|
|
|
| Gateway | Document | Window | Decision date | Owner | Stories | Main deliverable | Milestone |
|
|
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
| Project Setup | [MIL-001] | 2026-10-05 to 2026-10-07 | 2026-10-07 | S01 | none | Skeleton, tooling, README | [Milestone 40] |
|
|
| Coffee Machine Core | [MIL-002] | 2026-10-08 to 2026-10-10 | 2026-10-10 | S01 | none | Working program | [Milestone 41] |
|
|
| Quality and Publication | [MIL-003] | 2026-10-11 to 2026-10-12 | 2026-10-12 | S01 | none | Tests, Doxygen, published repo | [Milestone 42] |
|
|
| Code Review and CI | [MIL-004] | 2026-10-07 to 2026-10-12 | 2026-10-12 | S01 | none | Source review record, CI workflow | [Milestone 48] |
|
|
|
|
```plantuml
|
|
@startgantt
|
|
Project starts 2026-10-05
|
|
[Project Setup] starts 2026-10-05 and ends 2026-10-07
|
|
[Coffee Machine Core] starts 2026-10-08 and ends 2026-10-10
|
|
[Quality and Publication] starts 2026-10-11 and ends 2026-10-12
|
|
[MIL-001 Go/No-Go] happens 2026-10-07
|
|
[MIL-002 Go/No-Go] happens 2026-10-10
|
|
[MIL-003 Go/No-Go] happens 2026-10-12
|
|
[Code Review and CI] starts 2026-10-07 and ends 2026-10-12
|
|
[MIL-004 Go/No-Go] happens 2026-10-12
|
|
@endgantt
|
|
```
|
|
|
|
## Scope Coverage
|
|
|
|
| Business Case scope item | Gateway |
|
|
| --- | --- |
|
|
| Console program with `constants.py` | [MIL-002] |
|
|
| pytest tests | [MIL-003] |
|
|
| `pyproject.toml`, `.gitignore`, `Doxyfile`, README | [MIL-001] |
|
|
| Project documents | Planning, before [MIL-001] |
|
|
| Repository description and topics | [MIL-003] |
|
|
| Source code review record and CI workflow | [MIL-004] |
|
|
|
|
## Dependencies
|
|
|
|
```
|
|
MIL-001 -> MIL-002 -> MIL-003 -> MIL-004
|
|
```
|
|
|
|
A No-Go moves all later dates by the same amount.
|
|
|
|
## Plan Risks
|
|
|
|
| Risk | Impact | Mitigation |
|
|
| --- | --- | --- |
|
|
| The git host has no Actions runner | CI cannot run | Check the host first; if none, keep the workflow file and document the local commands |
|
|
| README template not supplied | README task blocked | Ask S01 for the template before the task |
|
|
| Doxygen not installed locally | Cannot verify docs | Document the install step in README |
|
|
|
|
## Open Issues
|
|
|
|
- The README template referenced in the request ("template below") was not included.
|
|
- No use cases or user stories are written; tasks are plain technical tasks implementing the assignment specification. S01 can ask for a use case ("Order a drink") if wanted.
|
|
- Python ">3.13" is read as 3.13 or newer (`>=3.13`).
|
|
|
|
---
|
|
|
|
[BC-001]: ./business-case.md
|
|
[SA-001]: ./stakeholder-analysis.md
|
|
[MIL-001]: ./milestones/mil-001-project-setup.md
|
|
[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
|
|
[Milestone 40]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/milestone/40
|
|
[Milestone 41]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/milestone/41
|
|
[Milestone 42]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/milestone/42
|
|
[c0c3940]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/commit/c0c3940551db0d7d96492cc734976d0436051ff9
|
|
[8ef00aa]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/commit/8ef00aafaaa193ea565f1a45238d31e963a5e05d
|
|
[Milestone 48]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/milestone/48
|