From 3f90c1beb40febfc86802dc1c62b1a321f9d662b Mon Sep 17 00:00:00 2001 From: Lou Bichard Date: Fri, 3 Mar 2023 11:37:05 +0200 Subject: [PATCH 1/7] Update epic.yml --- .github/ISSUE_TEMPLATE/epic.yml | 69 ++++++++------------------------- 1 file changed, 17 insertions(+), 52 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/epic.yml b/.github/ISSUE_TEMPLATE/epic.yml index 06ea9d58f2eb26..1bb3cf12255965 100644 --- a/.github/ISSUE_TEMPLATE/epic.yml +++ b/.github/ISSUE_TEMPLATE/epic.yml @@ -1,104 +1,69 @@ -name: Epic -description: Create an epic +name: Epic (User Impacting) +description: An epic is a grouping of related issues which MUST be delivered together. Epics are as small in scope as reasonably possible, and are "finite" in scope. Please do not use this template for: categorising related work (please instead use labels), investigate work where the solutions is not well defined (e.g. investgiations + spikes), or for technical debt work. title: "Epic: " labels: ["type: epic"] body: -- type: markdown - attributes: - value: Before raising an epic, please search for existing epics[[1](https://github.com/gitpod-io/gitpod/issues?q=is%3Aopen+is%3Aissue+label%3A%22type%3A+epic%22)][[2](https://github.com/gitpod-io/gitpod/issues?q=is%3Aopen+is%3Aissue+%22Epic%3A+%22)] to avoid creating duplicates. Read more about [Epics](https://www.notion.so/gitpod/Development-Process-2-0-6681854173ab4d2f92880f9f3d85cab5#321619f5a4bd4391be83c66feb2cdb49) (internal) in **Development Process**. - type: textarea - id: summary + id: press-release attributes: - label: Summary - description: TLDR description of the epic. Give a succinct and plain overview of what the epic is about. - placeholder: Give a succinct and plain overview of what the epic is about. + label: Press release (and FAQ's) + description: What would the future feature announcement look like from a customer/ user point of view? Think about questions both Gitpodders, and users/customers might ask about this feature. validations: - required: true + required: false - type: textarea id: context attributes: label: Context - description: What thinking led to this? Provide any necessary historical context required to understand this epic. - placeholder: Provide any necessary historical context required to understand this epic. + description: What thinking led to this issue? Provide any necessary historical context required to understand this epic. validations: - required: true + required: false - type: textarea id: value attributes: label: Value - description: Why should we do it? How do we know this is a real problem and worth solving? - placeholder: Explicitly describe the value to Gitpod and/or our users. I.e. why answer should we undertake this epic? + description: Why should we do this work? How do we know this is a real problem and worth solving? validations: - required: true + required: false - type: textarea id: acceptance-criteria attributes: label: Acceptance Criteria description: What needs to be done before the work is considered complete? The checks which must be complete for this epic to be considered done. - placeholder: Defines clearly when the work is complete. Acts as a litmus test for "done" and avoids "done" being ambiguous. Useful for implicit assumptions, e.g. ensuring docs updates are not forgotten. validations: - required: true + required: false - type: textarea id: measurement attributes: label: Measurement - description: How will we know whether we've been successful / solved the problem? How will you measure the success of the epic? Ideally this metric is one of our key product metrics. - placeholder: Important as it's how we track the outcomes (not just output) of the work and prove a change was worth it. Or it should be removed or iterated. - validations: - required: true -- type: textarea - id: growth-area - attributes: - label: Growth Area - description: Which aspect of Gitpod do we expect improvements in? Acquisition/Onboarding/Exploration/Expansion as defined in [Funnel Proposal](https://www.notion.so/gitpod/Funnel-Proposal-d7d0dba8aced4184b660092a74f8dd3a) (internal) - placeholder: Growth is key. This allows us to frame epics from a growth context. Which areas are we expecting this epic to help us with our growth initiatives? + description: What will we measure to know whether we've been successful? validations: required: false - type: textarea id: personas attributes: label: Persona(s) - description: Who will be impacted by this change? Which of our personas will be impacted by this change? - placeholder: Why? To bring persona's into our work. Persona's can help us prioritise our markets. Currently, we are not focusing on the education/training persona currently. We should avoid epics which target this persona. - validations: - required: false -- type: textarea - id: hypothesis - attributes: - label: Hypothesis - description: If we do X, we expect Y - placeholder: Can be useful if the work is explicitly experimental. + description: Optionally specifiy which user will be impacted by this change? + placeholder: [Developer/Installer/Project Configurer/Customer/Security Reviewer] (optionally the ecosystem persona e.g. Python Developers) validations: required: false - type: textarea id: in-scope attributes: label: In scope - description: Explicitly define the items in scope. - placeholder: Optional, sometimes is useful for explicitness. + description: Optionally define items explicitly in scope. validations: required: false - type: textarea id: out-of-scope attributes: label: Out of scope - description: Explicitly define the items out of scope. - placeholder: Optional, sometimes is useful for explicitness. + description: Optionally define items explicitly out of scope, to avoid side-quests and rabbitholes. validations: required: false - type: textarea id: complexities attributes: label: Complexities - description: Discuss any known complexities - placeholder: Optional, sometimes is useful for explicitness. - validations: - required: false -- type: textarea - id: press-release - attributes: - label: Press release - description: Create excitement about the idea - placeholder: Useful if you want to spend the extra time to get stakeholders, the team, or customers excited. + description: Optionally make explicit any complexities, e.g. dependencies on other teams, technical challenges, unknowns. validations: required: false From 1f7f8d3befcf095f2a79b4e916ba9cc9e102f44d Mon Sep 17 00:00:00 2001 From: Lou Bichard Date: Fri, 3 Mar 2023 14:12:16 +0200 Subject: [PATCH 2/7] Update .github/ISSUE_TEMPLATE/epic.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: André Duarte --- .github/ISSUE_TEMPLATE/epic.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/epic.yml b/.github/ISSUE_TEMPLATE/epic.yml index 1bb3cf12255965..bc69d31cabaf15 100644 --- a/.github/ISSUE_TEMPLATE/epic.yml +++ b/.github/ISSUE_TEMPLATE/epic.yml @@ -1,5 +1,5 @@ name: Epic (User Impacting) -description: An epic is a grouping of related issues which MUST be delivered together. Epics are as small in scope as reasonably possible, and are "finite" in scope. Please do not use this template for: categorising related work (please instead use labels), investigate work where the solutions is not well defined (e.g. investgiations + spikes), or for technical debt work. +description: An epic is a grouping of related issues which MUST be delivered together. Epics are as small in scope as reasonably possible, and are "finite" in scope. Please do not use this template for: categorising related work (please instead use labels), investigate work where the solutions is not well defined (e.g. investigations + spikes), or for technical debt work. title: "Epic: " labels: ["type: epic"] body: From 1805e2993d0fb8ad49d495658aa1bced37156919 Mon Sep 17 00:00:00 2001 From: Lou Bichard Date: Fri, 3 Mar 2023 14:12:34 +0200 Subject: [PATCH 3/7] Update .github/ISSUE_TEMPLATE/epic.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: André Duarte --- .github/ISSUE_TEMPLATE/epic.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/epic.yml b/.github/ISSUE_TEMPLATE/epic.yml index bc69d31cabaf15..f82a3163f8fecc 100644 --- a/.github/ISSUE_TEMPLATE/epic.yml +++ b/.github/ISSUE_TEMPLATE/epic.yml @@ -7,7 +7,7 @@ body: id: press-release attributes: label: Press release (and FAQ's) - description: What would the future feature announcement look like from a customer/ user point of view? Think about questions both Gitpodders, and users/customers might ask about this feature. + description: What would the future feature announcement look like from a customer/user point of view? Think about questions both Gitpodders, and users/customers might ask about this feature. validations: required: false - type: textarea From 09bfcd21d2c261f1be988413caef2a8503693f73 Mon Sep 17 00:00:00 2001 From: Lou Bichard Date: Fri, 3 Mar 2023 16:57:02 +0200 Subject: [PATCH 4/7] Update .github/ISSUE_TEMPLATE/epic.yml --- .github/ISSUE_TEMPLATE/epic.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/epic.yml b/.github/ISSUE_TEMPLATE/epic.yml index f82a3163f8fecc..663ca15607629d 100644 --- a/.github/ISSUE_TEMPLATE/epic.yml +++ b/.github/ISSUE_TEMPLATE/epic.yml @@ -1,5 +1,5 @@ name: Epic (User Impacting) -description: An epic is a grouping of related issues which MUST be delivered together. Epics are as small in scope as reasonably possible, and are "finite" in scope. Please do not use this template for: categorising related work (please instead use labels), investigate work where the solutions is not well defined (e.g. investigations + spikes), or for technical debt work. +description: An epic is a grouping of related issues which MUST be delivered together. Epics are as small in scope as reasonably possible, and are finite in scope. Please do not use this template for: categorising related work (please instead use labels), investigate work where the solutions is not well defined (e.g. investigations + spikes), or for technical debt work. title: "Epic: " labels: ["type: epic"] body: From 2b3c538cbf1c6c35872cc4623f517dcb802d7cd5 Mon Sep 17 00:00:00 2001 From: Lou Bichard Date: Fri, 3 Mar 2023 16:59:54 +0200 Subject: [PATCH 5/7] Update .github/ISSUE_TEMPLATE/epic.yml --- .github/ISSUE_TEMPLATE/epic.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/epic.yml b/.github/ISSUE_TEMPLATE/epic.yml index 663ca15607629d..5ae45ba2344632 100644 --- a/.github/ISSUE_TEMPLATE/epic.yml +++ b/.github/ISSUE_TEMPLATE/epic.yml @@ -1,5 +1,5 @@ name: Epic (User Impacting) -description: An epic is a grouping of related issues which MUST be delivered together. Epics are as small in scope as reasonably possible, and are finite in scope. Please do not use this template for: categorising related work (please instead use labels), investigate work where the solutions is not well defined (e.g. investigations + spikes), or for technical debt work. +description: An epic is a grouping of related issues which MUST be delivered together. Epics are as small in scope as reasonably possible, and are finite in scope. Please do not use this template for categorising related work, please instead use labels, investigate work where the solutions is not well defined e.g. investigations or spikes, or for technical debt work. title: "Epic: " labels: ["type: epic"] body: From 2d033d206097b8177d5383db03c271e44c4b2448 Mon Sep 17 00:00:00 2001 From: Lou Bichard Date: Fri, 3 Mar 2023 17:00:26 +0200 Subject: [PATCH 6/7] Update .github/ISSUE_TEMPLATE/epic.yml --- .github/ISSUE_TEMPLATE/epic.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/epic.yml b/.github/ISSUE_TEMPLATE/epic.yml index 5ae45ba2344632..0cc462fa23a291 100644 --- a/.github/ISSUE_TEMPLATE/epic.yml +++ b/.github/ISSUE_TEMPLATE/epic.yml @@ -43,7 +43,7 @@ body: attributes: label: Persona(s) description: Optionally specifiy which user will be impacted by this change? - placeholder: [Developer/Installer/Project Configurer/Customer/Security Reviewer] (optionally the ecosystem persona e.g. Python Developers) + placeholder: Developer/Installer/Project Configurer/Customer/Security Reviewer - optionally the ecosystem persona e.g. Python Developers validations: required: false - type: textarea From 255c2f229f549637599113733257d929c0335879 Mon Sep 17 00:00:00 2001 From: Lou Bichard Date: Fri, 3 Mar 2023 17:04:17 +0200 Subject: [PATCH 7/7] Update .github/ISSUE_TEMPLATE/epic.yml --- .github/ISSUE_TEMPLATE/epic.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/epic.yml b/.github/ISSUE_TEMPLATE/epic.yml index 0cc462fa23a291..55187cd90bb133 100644 --- a/.github/ISSUE_TEMPLATE/epic.yml +++ b/.github/ISSUE_TEMPLATE/epic.yml @@ -1,5 +1,5 @@ name: Epic (User Impacting) -description: An epic is a grouping of related issues which MUST be delivered together. Epics are as small in scope as reasonably possible, and are finite in scope. Please do not use this template for categorising related work, please instead use labels, investigate work where the solutions is not well defined e.g. investigations or spikes, or for technical debt work. +description: A group of related issues which MUST be delivered together, as small in scope as possible and finite (e.g not a grouping). This template is not designed for investigations, spikes, or tech-debt. title: "Epic: " labels: ["type: epic"] body: