update reporting guidelines #284
Open
+65
−81
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chair28980
requested review from
fryorcraken,
plopezlpz,
jm-clius,
weboko and
Ivansete-status
fryorcraken
approved these changes
Jan 24, 2025
|
|
||
| ### Engineering-Only Milestones | ||
|
|
||
| Some milestones may not involve the Waku Research team. In this case, the flow still applies but `E:research` is skipped. | ||
| Some milestones may not involve the Waku Research team. |
There was a problem hiding this comment.
this can be removed because we removed the flow above.
| <!-- | `E:dogfood` | js-waku, nwaku, bindings | Lab example updates, own nodes updated, etc. | Each dev team proceed by dogfooding the feature/API by using it themselves. Whether it is running their own node, or updating a selected number of examples. Go-waku can dogfood directly in status-go. | --> | ||
| <!-- | `E:docs` | Doc | Documentation (not auto-generated) | Document the new feature across all implementations, using the dogfooding output as handover material from engineering teams. This includes both coding guides but also a presentation ready visual documentation of the protocol behaviour. | --> | ||
| <!-- | `E:eco-dev` | Eco Dev | Dev Rel assets (examples, video tutorial, etc), comms plan (X threads, blog posts) | Dev Rel can now prepare assets to push the feature to developers, comms can prepare copies to communicate about it, BD can push it to projects and partners. | --> | ||
| Typically, each *milestone* will be divided in the following *deliverables*: |
There was a problem hiding this comment.
I think inaccurate, can be removed
Comment on lines
+52
to
+58
| ### Chat and other Special SDK Work | ||
|
|
||
| The Chat SDK team is focusing on go-waku integration in status-go and follows Status' PM for issues and labelling. | ||
| The Chat team is focusing on go-waku integration in status-go and follows Status' PM for issues and labelling. | ||
|
|
||
| Once the team starts building an independent Chat (or other) SDK, the flow will be as above but with research handled by VAC/ACZ and only one dev team: | ||
| Once the team starts building an independent Chat (or other) SDK, the flow will be as above but with research handled by VAC/ACZ and only one dev team. | ||
|
|
||
| | Epic Prefix | Owner Sub-team | Output | Description | | ||
| |--------------|----------------|----------------------------------------------------|------------------------------------------------------------| | ||
| | `E:acz` | Vac/ACZ | RFC | RFC describing a specific, likely agnostic protocol | | ||
| | `E:chat sdk` | Chat SDK | PoC and then MVP quality software, Application RFC | Implement the ACZ RFC, define API and application protocol | | ||
| Handover to VAC QA and VAC DST with MVP quality software is still expected down the track but may be pending growing teams. |
| @@ -34,55 +33,34 @@ A *Milestone*: | |||
|
|
|||
| ## Milestone scoping process flow | |||
|
|
|||
| Phase 1: Waku lead defines the scope within the Milestone. The scope is then discussed asynchronously in the comments of the GitHub issue by relevant subteams and stakeholders, scope of Epics and subtasks are defined. | |||
| Phase 1: Waku lead defines the scope within the Milestone. The scope is then discussed asynchronously in the comments of the GitHub issue by relevant subteams and stakeholders, scope of tasks are defined. | |||
|
|
|||
| Phase 2: During a Waku PM call, the team reviews the Milestone to confirm scope or identify areas that require additional scoping. | |||
There was a problem hiding this comment.
removed, we don't do that anymore
| Most epics will have a unique owner (e.g. a Waku Research team member owns a `E:research` epic). | ||
|
|
||
| The epic owner is responsible for breaking down the work in smaller issues in the related repo. | ||
|
|
||
| For research team, it is expected that most of the research work is done by the epic owner, which includes: |
There was a problem hiding this comment.
I would remove that. @jm-clius is accountable for research deliverables. How the work is assigned and done does not matter ofr the sake of this doc.
| @@ -8,56 +8,64 @@ The Waku Team is comprised of the following subteams: | |||
| - Waku Development nwaku, js-waku, go-waku | |||
Comment on lines
+11
to
15
| The Waku Team is also supported by other Logos groups, in particular: | ||
|
|
||
| - [VAC/DST](https://vac.dev/): Distributed System Testing Team for simulations and QA/Testing | ||
| - Comms Hub: For communications, marketing, digital content, etc. | ||
|
|
There was a problem hiding this comment.
Just remove this section
Ivansete-status
approved these changes
Jan 24, 2025
|
|
||
| Phase 2: During a Waku PM call, the team reviews the Milestone to confirm scope or identify areas that require additional scoping. | ||
|
|
||
| Phase 3: If the scope is agreed upon, the team can proceed to create Epics and schedule work for kickoff. | ||
|
|
||
| ## Workflow | ||
|
|
||
| A *Milestone* is divided into *Deliverables*. A *Deliverable* is divided into *Epics*. Each *Epic* is assigned to a given subteam. | ||
| A *Milestone* is divided into *Deliverables*. A *Deliverable* is divided into work that is assigned to a given subteam. |
There was a problem hiding this comment.
Maybe?
Suggested change
| A *Milestone* is divided into *Deliverables*. A *Deliverable* is divided into work that is assigned to a given subteam. | |
| A *Milestone* is divided into *Deliverables*. A *Deliverable* is divided into *Tasks* that are assigned to a given subteam. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reporting guidelines update for 2025.