waku-org/pm
1
0
Fork 0
mirror of https://github.com/waku-org/pm.git synced 2025-02-20 17:58:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
48 Commits 13 Branches 0 Tags 1.5 MiB
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
fryorcraken.eth 04a0315b0c
Removing epic of epics
2023-08-31 21:11:31 +10:00
.github
add labels to metrics repo
2023-08-30 08:40:48 +10:00
adr
adr: added message uid document
2023-03-22 12:43:51 +01:00
README.md
Removing epic of epics
2023-08-31 21:11:31 +10:00

README.md

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 yearly-ish Most subteams Waku Lead Key achievements for the Waku project, historical milestones.
Epic 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.
Task Many per Epic Set monthly-ish, delivered weekly One subteam or individual Team Member May be one or several piece of work, client specific.

Owner = person responsible for the delivery and related reporting, may not be doing all the work.

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 are added.
  • SHOULD have a roadmap to delivery done at planning phase, the GH milestone is then used to track progress.

An Epic:

A Task:

  • MAY be tracked as a todo item in a GH Issue (Task or Epic),
  • OR MAY be tracked as a single GH issue
    • that MUST be labelled with related Epic label (E:...),
  • OR MAY be tracked as a GH Pull Request
    • that MUST be labelled with related Epic label (E:...),
  • MUST have an acceptance criteria and/or a list of tasks (that can be other GH issues).

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 to be achieved, the Epics are being closed as the work is done across all clients.
  • To look at remaining work for an Epic, one need to look at all issues/PRs (Tasks) with the corresponding Epic label (E:...)

Reporting

Monthly:

Handled by insight team

Weekly: Report progress on each active Epic or Task per subteam.

Every Friday, all team members must add a comment to the GH issues they own and worked on the past week or planned to work on next week.

If work is done on several Tasks related to the same Epic, team member is free to do their weekly update in common parent issue.

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):

Description
Project management, admin, misc
Readme
Languages
Markdown 100%