logos-messaging/pm
1
0
Fork 0
mirror of https://github.com/logos-messaging/pm.git synced 2026-01-02 22:23:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #48 from waku-org/final-proposal

Browse Source
This commit is contained in:
fryorcraken 2023-09-05 15:14:31 +10:00 committed by GitHub
commit aebecc9b56
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -22,56 +22,57 @@ 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.
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 | 2-3 per _Priority Track_, total<=10 | Set yearly, delivered quarterly-ish | Several subteams | Waku Lead | Identified deliverables for each _Priority Track_. |
| Epic | Some per Milestone | Set quarterly-ish, delivered monthly | One subteam or external team (e.g. DST) | Team Member | Steps to deliver a _Milestone_. |
| Task | Many per Epic | Set monthly-ish, delivered weekly | One individual | Team Member | Smallest chunk of work to be delivered. |
| 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 of the milestone and related reporting.
Owner = person responsible for the delivery and related reporting, may not be doing all the work.
### GitHub Usage
For each:
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.
- _Milestone_, there is a GH issue under the https://github.com/waku-org/pm repo with `milestone` label assigned
- _Milestone_, there is a label with format `E:<year>-<milestone title>` created across all relevant https://github.com/waku-org/ repos (see [labels.yml](./.github/labels.yml)).
- _Epic_, there is a GH issue under the relevant https://github.com/waku-org/ repo with related _Milestone_ label (`E:...`) and `epic` label assigned. The GH issue is assigned to the _owner_ of the epic.
- _Task_, there is a GH issue and/or pull request under the relevant https://github.com/waku-org/ repo with related _Epic_ label.
An _Epic_:
- 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](./.github/labels.yml)).
- SHOULD be added to a GH Milestone.
- MAY list _Tasks_ present in other repos.
Hence, correct _Milestone_ 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.
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).
Ideally, every:
Which means, in terms of _navigation_:
- _Milestone_ GH issue contains a list of planned _Epics_.
- _Epic_ GH issue contains list of planned and completed _Tasks_.
Note: GitHub `milestone` functionality is **not** used as part of this process.
- 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**:
- Report progress of each _Milestone_
- Report _Epics_ that were closed last months and expected to be closed next month
- Other relevant items (RISK, etc)
Handled by insight team
**Weekly**: Report progress on each **active** _Epic_ per subteam.
**Weekly**: Report progress on each **active** _Epic_ or _Task_ 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.
Every Friday, all team members must add a comment to the GH **issues** (not pull request) 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:
@ -93,7 +94,7 @@ On Monday, project lead or responsible person for report can run the [milestone-
**Priority Tracks**: https://notes.status.im/Uz9HeCwZTDSYyOq36Q54cA#a
**Milestones** (WIP):
**Milestones** (to be changed):
- `E:2023-light-protocols` https://github.com/waku-org/pm/issues/25
- `E:2023-10k-users` https://github.com/waku-org/pm/issues/12