Skip to content
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 template for epic/story issues #1368

Merged
merged 3 commits into from
Jun 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/epic-or-story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
name: Epic/Story Issue Template
about: Template for "top" level issues - Epics (>2 weeks) / Stories (<2 weeks)
title: '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 <ip>:<port>
```

## 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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ terraform.*
crash.log
/build
/coverage

.idea/