diff --git a/README.md b/README.md index 863b2ab..d8499f3 100644 --- a/README.md +++ b/README.md @@ -19,45 +19,55 @@ See [PROCESS.md](./PROCESS.md) ## Reporting Guidelines -### Requirements +### Weekly Reporting -#### Weekly Reporting - -Weekly reporting provides an insight on the progress by milestones. - -### Reporting - -**Weekly Updates**: - -Report progress on each **active** Deliverables per sub-team. - -Every week, all team members must add their update in the appropriate discord thread *WITH LINKS* to the GitHub **issues** (not pull requests) they own and worked on over the past week and/or plan to work on next week. - -If work is done on several *Tasks* related to the same *Epic*, team members are free to link the common parent *Epic* issue. - -Please include an update for the following categories: - -- achieved: what was achieved this week. -- next: what will be worked on next. -- blocked: blocking items, not required if no blockers exist. - -PM compiles the updates following sign-off from sub-team Leads and publishes to https://roadmap.logos.co. - -### Process Flow +Weekly reporting provides an insight on the progress by Milestones. Updates are published to https://roadmap.logos.co/tags/waku-updates. +- Updates are collected and submitted by the team leads. +- Add to the relevant pull request in the roadmap repository: https://github.com/logos-co/roadmap/pulls +- Provide updates for each Deliverable currently in-progress. +- Use the achieved, next, blockers format templated under each Deliverable. +- Indicate if there is a scope change or due date change. +- Use the [Maintenance Deliverable](https://github.com/waku-org/pm/issues/275) for Maintenance, Tests, and Bugs that do not have a parent Milestone or Deliverable. +- Indicate which team the update is for, e.g.: ```md -Submit Updates (Everyone) - Tuesday - │ - ▼ -Review/Signoff (Leads) - Wednesday - │ - ▼ -Compile (PM) - Thursday - │ - ▼ -Publish (PM) - Monday + - achieved: + - [nwaku] Added testing for… + - [chat] Update libraries in… ``` ## Milestones -https://github.com/waku-org/pm/milestones +Milestones are defined in the Waku roadmap and tracked as Github in this repo. +Roadmap: https://roadmap.logos.co/waku/waku-milestones +Github: https://github.com/waku-org/pm/milestones + +![milestone-image](img/milestone.png) + +## Deliverables + +### Creation + +If a Deliverable has not yet been created, the Lead for the sub-team scheduled to kick-off the work. All Deliverables should be created in the Waku PM repo: https://github.com/waku-org/pm + +You can use the Deliverable template: https://github.com/waku-org/pm/issues/new?template=deliverable.md + +Upon creation of a Deliverable in Github please notify the PM. + +### Assignees + +For each team involved in work for the Deliverable, the Lead for that team should be an assignee on the Deliverable. + +### Adding sub-issues + +Create or add sub issues to the deliverable by using Github’s new “sub-issue” feature: + +![sub-issues-image](img/sub-issues.png) + +## Maintenance Deliverable + +This Maintenance Deliverable tracks all work not specifically described in the Waku roadmap covering Maintenance, Bugs, and Tests. + +[2025 H1 Maintenance Deliverable](https://github.com/waku-org/pm/issues/275) + +![maintenance-deliverable-image](img/maintenance.png) diff --git a/img/maintenance.png b/img/maintenance.png new file mode 100644 index 0000000..0323dce Binary files /dev/null and b/img/maintenance.png differ diff --git a/img/milestone.png b/img/milestone.png new file mode 100644 index 0000000..b994742 Binary files /dev/null and b/img/milestone.png differ diff --git a/img/sub-issues.png b/img/sub-issues.png new file mode 100644 index 0000000..a9313c7 Binary files /dev/null and b/img/sub-issues.png differ