Skip to content

Commit 263de7d

Browse files
gtsiolisroboquat
authored andcommitted
Add epic issue template
1 parent b2788a5 commit 263de7d

File tree

1 file changed

+104
-0
lines changed

1 file changed

+104
-0
lines changed

.github/ISSUE_TEMPLATE/epic.yml

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
name: Epic
2+
description: Create an epic
3+
title: "Epic: "
4+
labels: ["type: epic"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
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**.
9+
- type: textarea
10+
id: summary
11+
attributes:
12+
label: Summary
13+
description: TLDR description of the epic. Give a succinct and plain overview of what the epic is about.
14+
placeholder: Give a succinct and plain overview of what the epic is about.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: context
19+
attributes:
20+
label: Context
21+
description: What thinking led to this? Provide any necessary historical context required to understand this epic.
22+
placeholder: Provide any necessary historical context required to understand this epic.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: value
27+
attributes:
28+
label: Value
29+
description: Why should we do it? How do we know this is a real problem and worth solving?
30+
placeholder: Explicitly describe the value to Gitpod and/or our users. I.e. why answer should we undertake this epic?
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: acceptance-criteria
35+
attributes:
36+
label: Acceptance Criteria
37+
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.
38+
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.
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: measurement
43+
attributes:
44+
label: Measurement
45+
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.
46+
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.
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: growth-area
51+
attributes:
52+
label: Growth Area
53+
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)
54+
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?
55+
validations:
56+
required: false
57+
- type: textarea
58+
id: personas
59+
attributes:
60+
label: Persona(s)
61+
description: Who will be impacted by this change? Which of our personas will be impacted by this change?
62+
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.
63+
validations:
64+
required: false
65+
- type: textarea
66+
id: hypothesis
67+
attributes:
68+
label: Hypothesis
69+
description: If we do X, we expect Y
70+
placeholder: Can be useful if the work is explicitly experimental.
71+
validations:
72+
required: false
73+
- type: textarea
74+
id: in-scope
75+
attributes:
76+
label: In scope
77+
description: Explicitly define the items in scope.
78+
placeholder: Optional, sometimes is useful for explicitness.
79+
validations:
80+
required: false
81+
- type: textarea
82+
id: out-of-scope
83+
attributes:
84+
label: Out of scope
85+
description: Explicitly define the items out of scope.
86+
placeholder: Optional, sometimes is useful for explicitness.
87+
validations:
88+
required: false
89+
- type: textarea
90+
id: complexities
91+
attributes:
92+
label: Complexities
93+
description: Discuss any known complexities
94+
placeholder: Optional, sometimes is useful for explicitness.
95+
validations:
96+
required: false
97+
- type: textarea
98+
id: press-release
99+
attributes:
100+
label: Press release
101+
description: Create excitement about the idea
102+
placeholder: Useful if you want to spend the extra time to get stakeholders, the team, or customers excited.
103+
validations:
104+
required: false

0 commit comments

Comments
 (0)