From d1c5fcc1b840ca42ab30f62342dbddf32eed1e15 Mon Sep 17 00:00:00 2001 From: Oded Messer Date: Mon, 20 Mar 2023 10:56:55 +0200 Subject: [PATCH] Add template for epic/story issues (#9208) * Add template * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/epic_story.md | 60 ++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/epic_story.md diff --git a/.github/ISSUE_TEMPLATE/epic_story.md b/.github/ISSUE_TEMPLATE/epic_story.md new file mode 100644 index 000000000..4411cc9c6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/epic_story.md @@ -0,0 +1,60 @@ +--- +name: Epic/Story Issue Template +about: Template for "top" level issues - Epics (>2 weeks) / Stories (<2 weeks) +title: 'Epic: New Feature' +labels: epic +assignees: + +--- + +## Summary / Background +What do you want to achieve, why? business context +... + +## Scope + +What will be impacted and what won't be? +What needs implementation and what is invariant? +e.g. +- user should be able to run workflow X from UI +- enable workflow Y, Z from CLI + +## Assumptions +Product / UX assumptions as well as technical assumptions / limitations +e.g. +* Support only Python Runtime +* Focus on DVC experiments only +* Deployment environments don't change often and can be picked up from shared configuration + +## Open Questions +e.g. +- How should access control work for shared artifacts (workflow X) +- Python runtime assumption - is it really valid? in light of <...> + +## Blockers / Dependencies +List issues or other conditions / blockers + +## General Approach +Invocation example: +```shell +$ mapper-run task.tar.gz --ray-cluster : +``` + +## Steps + +### Must have (p1) +- [ ] subissue2 +- [ ] step 2 + - info + - info + +### Optional / followup (p2) +- [ ] ⌛ step 3 wip +- [ ] step 4 + +## Timelines + +Put your estimations here. Update once certainty changes +- end of week (Feb 3) for prototype with workflows X, Y +- Feb 15 - MVP in production +- Low priority followups can be done later