mirror of
https://github.com/waku-org/pm.git
synced 2025-02-23 11:18:12 +00:00
9f5271691e
Proposed for every milestone to be owned by a team member who is responsible to deliver the work and track. In some instances, several team members may work on the same milestone but a clear owner still needs to be defined.
99 lines
4.6 KiB
Markdown
99 lines
4.6 KiB
Markdown
# 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 currently done in a private Google Sheet and has the following sections:
|
|
- Progress on yearly milestones (10 milestones as defined in https://notes.status.im/Uz9HeCwZTDSYyOq36Q54cA#, now marked as _Epics_).
|
|
- Key achievements/highlights of previous month
|
|
- Planned achievement for next month
|
|
- RAID: Risks, Assumptions, Issues and Dependencies
|
|
- Identified Market Opportunities
|
|
|
|
The Google Sheet will soon be replaced by a dashboard that extract data using GitHub with the ability to organise the data by epic using GitHub labels.
|
|
|
|
### 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. |
|
|
| Epic | 2-3 per _Priority Track_, total<=10 | Set yearly, delivered quarterly-ish | Several subteams | Waku Lead | Identified deliverables for each _Priority Track_. |
|
|
| Milestone | Some per Epic | Set quarterly-ish, delivered monthly | One subteam or external team (e.g. DST) | Team Member | Steps to deliver an _Epic_. |
|
|
| Task | Many per Milestone | 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
|
|
|
|
For each:
|
|
|
|
- _Epic_, there is a GH issue under the https://github.com/waku-org/pm repo.
|
|
- _Epic_, there is a label with format `E:<year>-<epic title>` created across all relevant https://github.com/waku-org/ repos.
|
|
- _Milestone_, there is a GH issue under the relevant https://github.com/waku-org/ repo with related _Epic_ label and `milestone` label assigned. The GH issue is assigned to the _owner_ of the milestone.
|
|
- _Task_, there is a GH issue and/or pull request under the relevant https://github.com/waku-org/ repo with related _Epic_ label.
|
|
|
|
Hence, correct _Epic_ label must be assigned to all GH issues/pull requests representing a _Milestone_ or _Task_.
|
|
This will enable the usage of the new reporting dashboard and reduce manual maintenance.
|
|
|
|
Ideally, every:
|
|
|
|
- _Epic_ GH issue contains a list of planned _Milestones_.
|
|
- _Milestone_ GH issue contains list of planned and completed _Tasks_.
|
|
|
|
Note: GitHub `milestone` functionality is **not** used as part of this process.
|
|
|
|
### Reporting
|
|
|
|
**Monthly**:
|
|
|
|
- Report progress of each _Epic_
|
|
- Report _Milestones_ that were closed last months and expected to be closed next month
|
|
- Other relevant items (RISK, etc)
|
|
|
|
**Weekly**: Report progress on each **active** _Milestone_ per subteam.
|
|
|
|
Every Friday, all team members must add a comment to the `Milestone` 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:
|
|
|
|
```md
|
|
**Weekly Update**
|
|
|
|
_achieved_: what was achieved last week; must remain on one line.
|
|
_next_: what will be worked on next week; must also remain on one line.
|
|
_blocker_: any blocking items.
|
|
```
|
|
Omit the lines which are not relevant.
|
|
|
|
On Monday, project lead or responsible person for report can run the [milestone-update](https://github.com/fryorcraken/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
|
|
|
|
**Epics** (WIP):
|
|
|
|
- https://github.com/waku-org/pm/issues/25 `E:2023-light-protocols`
|
|
|