Skip to content
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/Epics template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Epic Template # Ensure no extra characters before "name"
description: High level issue for tracking an Epic.
title: "Epic: "
labels: ["Epic"]
body:
- type: textarea
id: description
attributes:
label: High level description of Epic.
value: A brief description of the Epic. What problem are we trying to solve? What value will it deliver?
validations:
required: true
- type: markdown
id: user stories
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Not sure if spaces in the id cause any issues, I recommend adding hyphens as done for other ids in this file.

attributes:
label: User Stories
value: |
List of User Stories associated with this Epic.
* User Story 1: (brief description)
* User Story 2: (brief description)
- type: markdown
id: acceptance criteria
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto

attributes:
label: Acceptance Criteria
value: |
Define the criteria for considering the Epic complete.
* Acceptance Criteria 1
* Acceptance Criteria 2
- type: markdown
id: prs-dependencies-blockers
attributes:
label: PRs, Dependencies and potential blockers of this Epic
value: |
List any Pull Requests (PRs) related to this Epic.
Describe any dependencies and potential blockers for the Epic.
Example: We are working on smart contract changes in order to deliver a new feature to our users.
Or This Epic is blocked by issue #34.
validations:
required: true
- type: markdown
id: related issues
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here as well

attributes:
label: Related Issues (Checklist)
value: |
**Checklist:**
- [ ] Issue #1: (brief description)
- [ ] Issue #2: (brief description)
- [ ] You can add more issues here following the same format.

**Note:** This checklist is for informational purposes only. You will need to manage the state of the issues manually.
- type: checkboxes
id: label-check
attributes:
label: Label Checks
options:
- label: I have added the team label(s) for this Epic.
required: true
- label: I have linked this Epic to its corresponding Project(s). (optional, adjust as needed)
required: false