Waku Project Management
Tracks/coordinate effort/tasks that targets Waku as a product across implementations (production readiness, scalability, etc).
Teams
The Waku Team is currently split in the following subteams:
- Waku Research
- Waku Development (nwaku, js-waku, go-waku)
- Waku Eco Dev (DevRel, Docs)
Work Tracking and Reporting Guidelines
Requirements
The current reporting requirements are 2 folds:
1. Weekly Reporting
Weekly reporting by subteam of progress on milestones.
2. Monthly Reporting
Monthly reporting is now handled by the Logos insight team.
Terminology
Name | Number of | Timeframe | Team Scope | Owner | Description |
---|---|---|---|---|---|
Priority Track | 3-5 | Set yearly | Whole Team | Waku Lead | Focus set for the year, must be aligned with Logos Collective's priorities. |
(Key) Milestone | 1-3 per year | Set yearlyish | Most subteams | Waku Lead | Key achievements for the Waku project, historical milestones. |
Epic of Epics | Several per milestone | Set for a milestone, delivered monthly | Several subteams or external team (e.g. DST) | Team Member (likely a lead) | Chunk of a _Milestone across all clients. |
Epic | One per subteam for a given epic of epics | Delivered monthly | One subteam | Team Member | Chunk of a _Milestone for a given client. |
Task | Many per Epic | Set monthly-ish, delivered weekly | One individual | Team Member | Smallest chunk of work to be delivered. |
Owner = person responsible for the delivery of the milestone and related reporting.
GitHub Usage
A Milestone:
- MUST have a matching GH issue in the https://github.com/waku-org/pm repo with
milestone
label assigned. - MUST have a GH Milestone in https://github.com/waku-org/pm repo, to which relevant Epics of epics are added.
- SHOULD have a roadmap to delivery done at planning phase, the GH milestone is then used to track progress.
An Epic of epics:
- MUST have a matching GH issue in the https://github.com/waku-org/pm with
epic
label assigned. - MUST have a label with format
E:<epic name>
created across all relevant https://github.com/waku-org/ repos (see labels.yml). - SHOULD be added to a GH Milestone.
- SHOULD list Epics present in other repos.
An Epic:
- MUST have a matching GH issue under the relevant https://github.com/waku-org/ repo, that
- MUST BE labelled with related Epic of epics label (
E:...
) - MUST BE labelled
epic
label. - MUST be assigned to the owner of the Epic.
- SHOULD contain a list of Tasks in its issue description.
- MUST BE labelled with related Epic of epics label (
A Task:
- MAY be tracked as a todo item in an Epic GH Issue,
- OR MAY be tracked as GH issue
- that SHOULD be labelled with related Epic of epics label (
E:...
),
- that SHOULD be labelled with related Epic of epics label (
- OR MAY be tracked as a GH Pull Request
- that SHOULD be labelled with related Epic of epics label (
E:...
).
- that SHOULD be labelled with related Epic of epics label (
Which means, in terms of navigation:
- Work for a Milestone is described in the related GitHub issue and tracked in the GitHub milestone.
- In the GitHub milestone, we have a list of Epics of epics to be achieved, the Epics of epics are being closed as the work is done across all clients.
- To look at remaining work for an epics of epics, one need to look at all issues (epics and tasks) with the corresponding epic of epics label (
E:...
)
Finally, ideally an Epic of epics do list the epics as a todo list in the GH issue description, but it's not mandatory for tracking. The same way, an Epic should list the tasks as a todo list in the GH issue description, but it's not mandatory as long as the acceptance criteria is clearly defined.
Reporting
Monthly:
Handled by insight team
Weekly: Report progress on each active Epic per subteam.
Every Friday, all team members must add a comment to the Epic GH issue they own and worked on the past week or planned to work on next week.
The comment must have the following MarkDown format:
**Weekly Update**
- _achieved_: what was achieved this week; must remain on one line.
- _next_: what will be worked on next week; must also remain on one line.
- _blocker_: any blocking items. Do not include the line if no blocker.
Omit the lines which are not relevant.
On Monday, project lead or responsible person for report can run the milestone-update script to generate a report and post it in the Logos Discord.
Work Tracking per Year
2023
Priority Tracks: https://notes.status.im/Uz9HeCwZTDSYyOq36Q54cA#a
Milestones (to be changed):
E:2023-light-protocols
https://github.com/waku-org/pm/issues/25E:2023-10k-users
https://github.com/waku-org/pm/issues/12E:2023-1mil-users
https://github.com/waku-org/pm/issues/31E:2023-dev-rel-assets
https://github.com/waku-org/pm/issues/32E:2023-peer-mgmt
https://github.com/waku-org/pm/issues/33E:2023-qa
https://github.com/waku-org/pm/issues/34E:2023-metrics
https://github.com/waku-org/pm/issues/35E:2023-eco-growth
https://github.com/waku-org/pm/issues/36E:2023-rln
https://github.com/waku-org/pm/issues/37E:2023-incentivize-operators
https://github.com/waku-org/pm/issues/38E:2023-many-platforms
https://github.com/waku-org/pm/issues/42