Skip to content

Commit 2af3eec

Browse files
committed
Add epic issue template
1 parent ac94f4f commit 2af3eec

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed

.github/ISSUE_TEMPLATE/epic.yml

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
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 issues to avoid creating duplicates. Read more about [Epics](https://www.notion.so/gitpod/Development-Process-2-0-6681854173ab4d2f92880f9f3d85cab5#321619f5a4bd4391be83c66feb2cdb49) in **Development Process** (internal).
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+
required: true
40+
- type: textarea
41+
id: measurement
42+
attributes:
43+
label: Measurement
44+
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.
45+
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.
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: growth-area
50+
attributes:
51+
label: Growth Area
52+
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)
53+
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?
54+
validations:
55+
required: false
56+
- type: textarea
57+
id: personas
58+
attributes:
59+
label: Persona(s)
60+
description: Who will be impacted by this change? Which of our personas will be impacted by this change?
61+
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.
62+
validations:
63+
required: false
64+
- type: textarea
65+
id: hypothesis
66+
attributes:
67+
label: Hypothesis
68+
description: If we do X, we expect Y
69+
placeholder: Can be useful if the work is explicitly experimental.
70+
validations:
71+
required: false
72+
- type: textarea
73+
id: in-scope
74+
attributes:
75+
label: In scope
76+
description: Explicitly define the items in scope.
77+
placeholder: Optional, sometimes is useful for explicitness.
78+
validations:
79+
required: false
80+
- type: textarea
81+
id: out-of-scope
82+
attributes:
83+
label: Out of scope
84+
description: Explicitly define the items out of scope.
85+
placeholder: Optional, sometimes is useful for explicitness.
86+
validations:
87+
required: false
88+
- type: textarea
89+
id: complexities
90+
attributes:
91+
label: Complexities
92+
description: Discuss any known complexities
93+
placeholder: Optional, sometimes is useful for explicitness.
94+
validations:
95+
required: false
96+
- type: textarea
97+
id: press-release
98+
attributes:
99+
label: Press release
100+
description: Create excitement about the idea
101+
placeholder: Useful if you want to spend the extra time to get stakeholders, the team, or customers excited.
102+
validations:
103+
required: false

0 commit comments

Comments
 (0)