pm/README.md

66 lines
2.3 KiB
Markdown
Raw Normal View History

2022-10-26 10:40:22 +11:00
# Waku Project Management
2023-07-31 16:56:18 +10:00
## Teams
2024-10-25 00:01:30 -07:00
The Waku Team is comprised of the following subteams:
2023-07-31 16:56:18 +10:00
- Waku Research
2025-01-28 19:03:20 -08:00
- Waku Development: nwaku, js-waku
2024-10-25 00:01:30 -07:00
- Waku Chat
2024-01-10 15:07:06 +11:00
2025-01-22 22:30:38 -08:00
*For tracking and project management processes please see* [PROCESS.md](./PROCESS.md)
2024-01-22 11:41:49 +11:00
## Reporting Guidelines
2023-07-31 16:56:18 +10:00
2025-01-22 22:12:23 -08:00
### Weekly Reporting
2023-07-31 16:56:18 +10:00
2025-01-22 22:12:23 -08:00
Weekly reporting provides an insight on the progress by Milestones. Updates are published to https://roadmap.logos.co/tags/waku-updates.
2023-07-31 16:56:18 +10:00
2025-01-22 22:12:23 -08:00
- 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
- achieved:
- [nwaku] Added testing for…
- [chat] Update libraries in…
```
2023-07-31 16:56:18 +10:00
2025-01-22 22:12:23 -08:00
## Milestones
2023-07-31 17:03:02 +10:00
2025-01-22 22:12:23 -08:00
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
2023-08-31 21:11:31 +10:00
2025-01-22 22:24:02 -08:00
<img src="img/milestone.png" width="500" height="375">
2025-01-22 22:20:27 -08:00
2025-01-22 22:12:23 -08:00
## Deliverables
2023-08-02 13:40:31 +10:00
2025-01-22 22:12:23 -08:00
### Creation
2023-08-02 13:40:31 +10:00
2025-01-22 22:12:23 -08:00
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
2023-08-02 13:40:31 +10:00
2025-01-22 22:12:23 -08:00
You can use the Deliverable template: https://github.com/waku-org/pm/issues/new?template=deliverable.md
2023-08-02 13:40:31 +10:00
2025-01-22 22:12:23 -08:00
Upon creation of a Deliverable in Github please notify the PM.
2025-01-22 22:12:23 -08:00
### Assignees
2023-08-02 13:40:31 +10:00
2025-01-22 22:12:23 -08:00
For each team involved in work for the Deliverable, the Lead for that team should be an assignee on the Deliverable.
2023-08-02 13:40:31 +10:00
2025-01-22 22:12:23 -08:00
### Adding sub-issues
Create or add sub issues to the deliverable by using Githubs 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)
2023-07-31 16:58:16 +10:00
2025-01-22 22:24:02 -08:00
<img src="img/maintenance.png" width="500" height="375">