-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Add epic issue template #7556
Add epic issue template #7556
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Associated issue: #321619 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Codecov Report
@@ Coverage Diff @@
## main #7556 +/- ##
=========================================
- Coverage 10.81% 9.53% -1.29%
=========================================
Files 20 18 -2
Lines 1248 1080 -168
=========================================
- Hits 135 103 -32
+ Misses 1110 976 -134
+ Partials 3 1 -2
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
2af3eec
to
dc01d2b
Compare
Opened this in case it's helpful during opening a new epic. Feel free to update per need or close if this looks unessesary. 📕 Cc @csweichel @svenefftinge because Development Process (internal) Cc @jldec @loujaybee @metcalfc because Product Sync[1] (internal) |
dc01d2b
to
5c7faea
Compare
5c7faea
to
87e7b3b
Compare
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Reopening this after a discussion in our product sync. We want to use this as a baseline to iterate on an epic template that aims to help standardise epics and help epic creators think about a minimal set criteria that underline the value and intent of their epic. |
- 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given we're not actively using persona's widely in the company, I'd suggest removing this for now.
- 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: 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. | ||
validations: | ||
required: false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd suggest we remove this, I think the original intent for PRFAQ process was misunderstood, I don't think this makes sense to do as part of our epic template.
- 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. | |
validations: | |
required: false |
Thanks for re-opening this, @lucasvaltl! Adding a few more points in favor of merging this as I've noticed some counter points for using plain markdown here instead of a form:
|
- 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Measurement and hypothesis are quite closely linked, should we merge the two for simplicity?
- 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: hypothesis-measurement | |
attributes: | |
label: Hypothesis & Measurement | |
description: What behaviour change are we expecting to see in our user base? And how will that behaviour change be measured? 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: hypothesis | ||
attributes: | ||
label: Hypothesis | ||
description: If we do X, we expect Y | ||
placeholder: Can be useful if the work is explicitly experimental. | ||
validations: | ||
required: false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest removing, and merging with measurement [1]
- 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. | |
validations: | |
required: false |
fyi: Also, friendly reminder that the moment we change anything in this issue template, we'll be deviating from the initial structure defined in the Development Process 2.0 / Epics (internal), moving away from a single source of truth (SSOT). Not advocating against any changes but bringing this up for visibility as this can also affect how we ship skateboards. ❗ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @lucasvaltl and @gtsiolis !
Left a few comments to simplify and consolidate some fields. ✅ Approving as we can always iterate in future. ♻️ That said, I'll still personally continue to write out these templates as tables using tablesgenerator.com (examples: #7570, #8513).
Worth stressing that a huge aspect to these templates is 🧠 education and alignment. Creating the template is only the first tiny part. e.g. the measurement
field needs to ideally be part of a cultural shift towards empowering teams with outcomes, rather than features. For as long as we're used to handing features to teams, but expecting teams to measure against outcomes, passing outcome measurements in this way will likely never feel natural.
Good process serves you so you can serve customers. But if you’re not watchful, the process can become the thing. [...] The process becomes the proxy for the result you want. You stop looking at outcomes and just make sure you’re doing the process right. Gulp [...] The process is not the thing. (source)
🙏 Happy to ship 🛹 and iterate!
@loujaybee I actually quite like the changes you proposed because the reduce clutter and simplify the template, which makes it less overwhelming. To move forward on them, it might be best to create a new PR for your changes so we can discuss them and merge them as an iteration on what we have now? As @gtsiolis said, we'd have to make sure we keep Development Process 2.0 / Epics (internal) in sync. |
Description
This will add an Epic template according to the Epics (internal) the new Development Process (internal) using Issue Forms[1]. Alternatively, instead of the issue form this could use plain markdown and inline all comments to make the template more compact.
See how the bug report renders. See also
bug_report.yml
andepic.yml
.Release Notes