From 6bf0f60ca65e016b3e9bac8a332396a7ee8c2762 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Mon, 31 Jul 2023 16:56:18 +1000 Subject: [PATCH 1/6] Set guidelines --- .github/labels.yml | 2 +- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 56 insertions(+), 4 deletions(-) diff --git a/.github/labels.yml b/.github/labels.yml index 90060ce..426cb75 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -86,7 +86,7 @@ description: go-waku productionization track (Waku Product) color: 9DEA79 -# Epics/Milestones +# Epics - name: E:2023-light-protocols description: https://github.com/waku-org/pm/issues/25 color: FEF445 diff --git a/README.md b/README.md index 9fe11b7..a8a1a1d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,59 @@ # Waku Project Management - Tracks/coordinate effort/tasks that targets Waku as a product across implementations (production readiness, scalability, etc). -Implementation specific tasks should be tracked in matching repos. -Secure Messaging Research is tracked in [Vac Org](github.com/vacp2p/research/). +## 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. See https://notes.status.im/waku-2023-report as the initiating document + +#### 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 | Description | +|----------------|-------------------------------------|--------------------------------------|------------------|-----------------------------------------------------------------------------| +| Priority Track | 3-5 | Set yearly | Whole Team | 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 | Identified deliverables for each _Priority Track_. | +| Milestone | Some per Epic | Set quarterly-ish, delivered monthly | One subteam | Steps to deliver an _Epic_. | +| Task | Many per Milestone | Set monthly-ish, delivered weekly | One individual | Smallest chunk of work to be delivered. | + +### 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:-` 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. +- _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_. + From adedb27e71d7a6a99f06b87c572c4a2922af0733 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Mon, 31 Jul 2023 16:58:16 +1000 Subject: [PATCH 2/6] Add references to 2023 --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a8a1a1d..822ef81 100644 --- a/README.md +++ b/README.md @@ -57,3 +57,13 @@ Ideally, every: - _Epic_ GH issue contains a list of planned _Milestones_. - _Milestone_ GH issue contains list of planned and completed _Tasks_. +## 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` + From 36ab80fce317af71ea032d721e1bed816664aa8e Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Mon, 31 Jul 2023 16:59:03 +1000 Subject: [PATCH 3/6] Add references to 2023 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 822ef81..0e34b6b 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,6 @@ Ideally, every: **Priority Tracks**: https://notes.status.im/Uz9HeCwZTDSYyOq36Q54cA#a **Epics** (WIP): -- + - https://github.com/waku-org/pm/issues/25 `E:2023-light-protocols` From 4d67784847f41074df37d392f6431fb76f52849a Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Mon, 31 Jul 2023 17:03:02 +1000 Subject: [PATCH 4/6] Add reporting --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 0e34b6b..9d67570 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,16 @@ Ideally, every: - _Epic_ GH issue contains a list of planned _Milestones_. - _Milestone_ GH issue contains list of planned and completed _Tasks_. +### 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. + ## Work Tracking per Year ### 2023 From a3350983019a61e52c4d52d84989cb27df9af504 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Tue, 1 Aug 2023 10:58:26 +1000 Subject: [PATCH 5/6] mention GH milestones --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9d67570..96a13ac 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,8 @@ 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**: From 3f59ce6c71dd414f31aa9c0f131eddb86bed273d Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Tue, 1 Aug 2023 10:59:51 +1000 Subject: [PATCH 6/6] Mention external teams (dependencies) --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 96a13ac..804a31c 100644 --- a/README.md +++ b/README.md @@ -33,12 +33,12 @@ The Google Sheet will soon be replaced by a dashboard that extract data using Gi ### Terminology -| Name | Number of | Timeframe | Team Scope | Description | -|----------------|-------------------------------------|--------------------------------------|------------------|-----------------------------------------------------------------------------| -| Priority Track | 3-5 | Set yearly | Whole Team | 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 | Identified deliverables for each _Priority Track_. | -| Milestone | Some per Epic | Set quarterly-ish, delivered monthly | One subteam | Steps to deliver an _Epic_. | -| Task | Many per Milestone | Set monthly-ish, delivered weekly | One individual | Smallest chunk of work to be delivered. | +| Name | Number of | Timeframe | Team Scope | Description | +|----------------|-------------------------------------|--------------------------------------|-----------------------------------------|-----------------------------------------------------------------------------| +| Priority Track | 3-5 | Set yearly | Whole Team | 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 | Identified deliverables for each _Priority Track_. | +| Milestone | Some per Epic | Set quarterly-ish, delivered monthly | One subteam or external team (e.g. DST) | Steps to deliver an _Epic_. | +| Task | Many per Milestone | Set monthly-ish, delivered weekly | One individual | Smallest chunk of work to be delivered. | ### GitHub Usage