Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update process doc #269

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

update process doc #269

wants to merge 8 commits into from

Conversation

chair28980
Copy link
Contributor

@chair28980 chair28980 commented Oct 25, 2024

Update process doc and readme.

  • Removed monthly reporting section as insights processes updates underway.
  • Removed Docs, eco-dev, bindings, and go-waku epics.
  • Updated reporting process, added TLDR.

Needs mermaid flow chart update.

PROCESS.md Show resolved Hide resolved
PROCESS.md Outdated Show resolved Hide resolved
PROCESS.md Outdated Show resolved Hide resolved
| Epic | Several per milestone | Set for a milestone | Usually one subteam or external team (e.g. DST) | Subteam Lead or Member | Milestone work for a given subteam. |
| 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. |
| Deliverable | Several per milestone | Set for a milestone | Subtean leads | Subteam Lead or Member | Milestone work for a given subteam. |
| Epic | Several per deliverable | Set for a deliverable | Usually one subteam or external team (e.g. DST) | Subteam Lead or Member | Milestone work for a given subteam. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Epic | Several per deliverable | Set for a deliverable | Usually one subteam or external team (e.g. DST) | Subteam Lead or Member | Milestone work for a given subteam. |
| Epic | Several per deliverable | Set for a deliverable | One subteam | Subteam Lead | The work of a team for a given deliverable. |

As discussed, we move away from epics for several subteam (dogfood) or for non waku teams (QA).

One epic = work of a waku subteam for a given deliverable.

subteam lead is accountable to ensure work is delivered, dogfed and handed over to QA, DST, eco dev or other waku subteam.

| 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. |
| Deliverable | Several per milestone | Set for a milestone | Subtean leads | Subteam Lead or Member | Milestone work for a given subteam. |
| Epic | Several per deliverable | Set for a deliverable | Usually one subteam or external team (e.g. DST) | Subteam Lead or Member | Milestone work for a given subteam. |
| Task | Several per Epic | Set monthly-ish, delivered weekly | One subteam or individual | Team Member | May be one or several piece of work, client specific. |q
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Task | Several per Epic | Set monthly-ish, delivered weekly | One subteam or individual | Team Member | May be one or several piece of work, client specific. |q
| Task | Several per Epic | Set monthly-ish, delivered weekly | One subteam or individual | Team Member | May be one or several piece of work, client specific. |

| 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. |
| Deliverable | Several per milestone | Set for a milestone | Subtean leads | Subteam Lead or Member | Milestone work for a given subteam. |
| Epic | Several per deliverable | Set for a deliverable | Usually one subteam or external team (e.g. DST) | Subteam Lead or Member | Milestone work for a given subteam. |
| Task | Several per Epic | Set monthly-ish, delivered weekly | One subteam or individual | Team Member | May be one or several piece of work, client specific. |q

## Milestone Definition

A *Milestone*:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is now a "Deliverable" definition. But I think we can remove the "bundle" concept

- SHOULD be added to a GitHub Milestone.
- MUST have a matching GitHub issue in the relevant team's repo.
- MUST have a label with format `Epic`.
- MUST be added to the description of the parent _Deliverable_ issue.
- SHOULD have a `Planned Start` and `Due Date` set (these are GitHub projects fields you can find in the `Projects` section of the issue view sidebar).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need dates on deliverables too, right?

- MUST have an _acceptance criteria_ and/or a list of _tasks_ (that can be other GH issues).

Finally, for _Tasks_ that do not belong to a given _Epic_ or _Milestone_:
Finally, for _Tasks_ that do not belong to a given _Epic_ or _Deliverable_:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe specified that a task MUST belong to an epic or have one of those below.

- `dependencies`: Upgrade dependencies in a timely manner to avoid time wasting when the dependency upgrade becomes critical.

- `bug`: This is a bug, likely reported by a user
- `maintenance`: This is maintenence work that is out of the scope of the technical roadmap
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `maintenance`: This is maintenence work that is out of the scope of the technical roadmap
- `maintenance`: This is maintenance work that is out of the scope of the technical roadmap

- In the GitHub milestone, we have a list of _Epics_ to be achieved, the _Epics_ are being closed as the work is done and handed over.
- To look at remaining work for an _Epic_, one need to look at all issues (_Tasks_) with the corresponding _Epic_ label (`E:...`)
- Milestones and Deliverables are defined in the pm repo
- Deliverables have many epics, one epic per team
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Deliverables have many epics, one epic per team
- Deliverables have one or several epics, one epic per subteam

- To look at remaining work for an _Epic_, one need to look at all issues (_Tasks_) with the corresponding _Epic_ label (`E:...`)
- Milestones and Deliverables are defined in the pm repo
- Deliverables have many epics, one epic per team
- Team lead is responsible to ensure Vac-QA is aware of changes, but no need to create a QA epic
Copy link
Contributor

@fryorcraken fryorcraken Oct 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's have a table

Task Responsible Accountable
Set Milestones and Deliverables in master document Waku Lead Insights
Create GitHub milestones and deliverables issues in pm repo Program Manager Waku Lead
Create epic for team Team Lead Program Manager
Create issues, PR (tasks) and link them to epics Team Member Team Lead
Close epic Team Lead Program Manager
Close deliverable Waku Lead Program Manager
Handover to Vac-QA, Vac-DST Team Lead Vac PoC (?)
Proceed with Dogfooding Team Lead Waku Lead

Responsible: who does it
Accountable: delegates and review

Waku Lead: @fryorcraken
Program Manager: @chair28980
Team Lead: @plopezlpz @Ivansete-status @jm-clius @weboko
Vac PoC: @jm-clius (?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants