From e3b17aa1183e33b0fe3eca359fd70869941e10b9 Mon Sep 17 00:00:00 2001 From: omesser Date: Sun, 19 Mar 2023 03:10:22 +0200 Subject: [PATCH 1/2] Add template for epic/story issues --- .github/ISSUE_TEMPLATE/epic-or-story.md | 69 +++++++++++++++++++++++++ .gitignore | 2 + 2 files changed, 71 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/epic-or-story.md diff --git a/.github/ISSUE_TEMPLATE/epic-or-story.md b/.github/ISSUE_TEMPLATE/epic-or-story.md new file mode 100644 index 000000000..0b8bb5f41 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/epic-or-story.md @@ -0,0 +1,69 @@ +--- +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 diff --git a/.gitignore b/.gitignore index 000f8d81c..9727194aa 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,5 @@ terraform.* crash.log /build /coverage + +.idea/ \ No newline at end of file From 581ef63a77a230be99682e5355b2d03eb0ac1a82 Mon Sep 17 00:00:00 2001 From: omesser Date: Thu, 23 Mar 2023 15:33:31 +0200 Subject: [PATCH 2/2] Update title - don't repeat label --- .github/ISSUE_TEMPLATE/epic-or-story.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/epic-or-story.md b/.github/ISSUE_TEMPLATE/epic-or-story.md index 0b8bb5f41..92a0929aa 100644 --- a/.github/ISSUE_TEMPLATE/epic-or-story.md +++ b/.github/ISSUE_TEMPLATE/epic-or-story.md @@ -1,7 +1,7 @@ --- name: Epic/Story Issue Template about: Template for "top" level issues - Epics (>2 weeks) / Stories (<2 weeks) -title: 'Epic: New Feature' +title: 'New Feature' labels: epic assignees: ---