From 249d436a200baf43bcfc79368395ba4f1b79187b Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Wed, 20 Sep 2023 12:31:34 +1000 Subject: [PATCH] Address how to handle work that is not part of the roadmap --- .github/labels.yml | 6 +++--- README.md | 10 ++++++++++ 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/.github/labels.yml b/.github/labels.yml index 467486f..2069b8e 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -20,9 +20,6 @@ - name: invalid description: This doesn't seem right color: e4e669 -- name: question - description: Further information is requested - color: d876e3 - name: wontfix description: This will not be worked on color: ffffff @@ -47,6 +44,9 @@ - name: release-notes description: Issue/PR needs to be evaluated for inclusion in release notes highlights or upgrade instructions color: fb3c99 +- name: dependencies + description: Pull requests that update a dependency file or issues that track it + color: 0366d6 # Tracks - name: track:rln diff --git a/README.md b/README.md index 8bd9338..3098ffa 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ 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:` created across all relevant https://github.com/waku-org/ repos (see [labels.yml](./.github/labels.yml)). - SHOULD be added to a GH Milestone. +- 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). - MAY list _Tasks_ present in other repos. A _Task_: @@ -56,6 +57,15 @@ A _Task_: - 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). +Finally, for _Tasks_ that do not belong to a given _Epic_ or _Milestone_: +- MUST have either labels: + - `bug`: This is a bug, likely reported by a user + - `enhancement`: This is an enhancement out of the scope of the technical roadmap, likely reported by a user + - Major enhancements should be carefully reviewed and prioritized. + - `documentation`: Documentation improvement or correction. + - `dependencies`: Upgrade dependencies in a timely manner to avoid time wasting when the dependency upgrade becomes critical. + + Which means, in terms of _navigation_: - Work for a Milestone is described in the related GitHub issue and tracked in the GitHub milestone.