Skip to content

Commit 861cd57

Browse files
chore: create issue templates for project planning (#361)
* chore: create issue templates for project planning related: #327 This commit creates 3 new GitHub issue templates to help with Notebooks 2.0 project planning. As recently agreed upon in community meetings - we want to break down work into 3 hierarchical categories: - Epics - Features - Tasks The templates defined in this pull request mimic the format @ederign used when initially defining work for our first "sprint" of work. :warning: Please note, however, I have introduced the term `Task` to capture the most granular issue type. Happy to change the word to something else - but wanted a `[...]` prefix to identify these issues similar to `[EPIC]` and `[FEATURE]` These issue templates would not be intended to be used by "random" community members - rather they are designed to aid Epic Owners in defining work. For now, I have just added a simple "disclaimer" in the issue template summary to discourage use. In the future we could discuss extending `internal-acls` and leveraging GitHub Actions to ensure these "planning" templates are only used by designated community members. The `Epic` and `Feature` templates **DO NOT** have a section to track child items included in the issue description. The desire to merge #325 to leverage GitHub sub-issues to more naturally track these relationships and avoid having to "ping" issue authors to update the description to track children. The `config.yml` `issue_templates` section is used to define a deterministic order within the GitHub Template Chooser modal. As we can control the order through this file along - I also removed the leading numerical prefixes from existing yml template files as they serve no purpose and at worst could actively confuse. Signed-off-by: Andy Stoneberg <[email protected]> * mathew: update epic label Signed-off-by: Mathew Wicks <[email protected]> * Update .github/ISSUE_TEMPLATE/planning_task.yml Signed-off-by: Mathew Wicks <[email protected]> * mathew: update feature label Signed-off-by: Mathew Wicks <[email protected]> * mathew: remove emoji from planning names Signed-off-by: Mathew Wicks <[email protected]> --------- Signed-off-by: Andy Stoneberg <[email protected]> Signed-off-by: Mathew Wicks <[email protected]> Co-authored-by: Mathew Wicks <[email protected]>
1 parent 920944f commit 861cd57

File tree

6 files changed

+121
-0
lines changed

6 files changed

+121
-0
lines changed
File renamed without changes.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
blank_issues_enabled: true
2+
3+
issue_templates:
4+
- bug_report.yml
5+
- feature_request.yml
6+
- planning_epic.yml
7+
- planning_feature.yml
8+
- planning_task.yml
9+
210
contact_links:
311
- name: Kubeflow Documentation
412
url: https://www.kubeflow.org/
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: "[Planning] Epic"
2+
description: "🛑 Only intended to be used by Kubeflow project managers"
3+
title: "[EPIC] <short description>"
4+
labels:
5+
- "kind/plan-epic"
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to create an epic!
12+
- type: checkboxes
13+
id: certification
14+
attributes:
15+
label: Certification
16+
description: Please confirm your role
17+
options:
18+
- label: I certify I am an Epic Owner for Kubeflow Notebooks 2.0 and expected to create planning-related issues.
19+
required: true
20+
- type: textarea
21+
id: user-story
22+
attributes:
23+
label: User Story
24+
description: Describe the feature from the end user's perspective, including who they are, what they want to achieve, and why it's important.
25+
placeholder: As a [type of user], I want [goal] so that [benefit]
26+
validations:
27+
required: true
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: "[Planning] Feature"
2+
description: "🛑 Only intended to be used by Kubeflow project managers"
3+
title: "[FEATURE] <short description>"
4+
labels:
5+
- "kind/plan-feature"
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to create a feature request!
12+
- type: checkboxes
13+
id: certification
14+
attributes:
15+
label: Certification
16+
description: Please confirm your role
17+
options:
18+
- label: I certify I am an Epic Owner for Kubeflow Notebooks 2.0 and expected to create planning-related issues.
19+
required: true
20+
- type: textarea
21+
id: motivation
22+
attributes:
23+
label: Motivation
24+
description: Explain the reasoning behind this feature. What problem does it solve or what value does it add?
25+
placeholder: This feature will help users by...
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: design
30+
attributes:
31+
label: High Level Design / Mock-ups
32+
description: Provide a top-level overview of the proposed solution. Include diagrams, rough mockups, or architectural notes if helpful.
33+
placeholder: |
34+
[Add your design details here]
35+
- Consider including diagrams
36+
- Add mockups if available
37+
- Describe the architecture
38+
- type: textarea
39+
id: acceptance-criteria
40+
attributes:
41+
label: Acceptance Criteria
42+
description: Define what needs to be true for this feature to be considered complete. Be as clear and measurable as possible.
43+
placeholder: |
44+
- [ ] Criterion 1
45+
- [ ] Criterion 2
46+
- [ ] Criterion 3
47+
validations:
48+
required: true
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: "[Planning] Task"
2+
description: "🛑 Only intended to be used by Kubeflow project managers"
3+
title: "[TASK] <short description>"
4+
labels:
5+
- "kind/plan-task"
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to create a task!
12+
- type: checkboxes
13+
id: certification
14+
attributes:
15+
label: Certification
16+
description: Please confirm your role
17+
options:
18+
- label: I certify I am an Epic Owner for Kubeflow Notebooks 2.0 and expected to create planning-related issues.
19+
required: true
20+
- type: textarea
21+
id: description
22+
attributes:
23+
label: Description
24+
description: Provide a brief explanation of what this task involves and why it's needed. Focus on the scope and intent of the work.
25+
placeholder: This task will...
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: acceptance-criteria
30+
attributes:
31+
label: Acceptance Criteria
32+
description: List the specific, measurable conditions that must be met for the task to be considered complete.
33+
placeholder: |
34+
- [ ] Criterion 1
35+
- [ ] Criterion 2
36+
- [ ] Criterion 3
37+
validations:
38+
required: true

0 commit comments

Comments
 (0)