Skip to content

Commit e36e293

Browse files
michael-valdronmichael-valdron
committed
github issue forms
Signed-off-by: Michael Valdron <[email protected]>
1 parent 22740cb commit e36e293

13 files changed

+322
-347
lines changed

‎.github/ISSUE_TEMPLATE/1_bug_report.yml

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: Bug report
2+
description: 🐞 Report a bug
3+
labels:
4+
- kind/bug
5+
body:
6+
- type: dropdown
7+
attributes:
8+
label: Which area is this bug related to?
9+
description: Choose the area(s) this bug is related to.
10+
multiple: true
11+
options:
12+
- /area ci
13+
- /area api
14+
- /area library
15+
- /area registry
16+
- /area registry-viewer
17+
- /area alizer
18+
- /area devworkspace
19+
- /area integration-tests
20+
- /area test-automation
21+
- /area releng
22+
- /area landing-page
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: What versions of software are you using?
28+
description: Choose and fill in the applicable
29+
value: |
30+
#### Go project
31+
32+
**Operating System and version:**
33+
34+
**Go Pkg Version:**
35+
36+
#### Node.js project
37+
38+
**Operating System and version:**
39+
40+
**Node.js version:**
41+
42+
**Yarn version:**
43+
44+
**Project.json:**
45+
46+
#### Web browser
47+
48+
**Operating System and version:**
49+
50+
**Browser name and version:**
51+
- type: textarea
52+
attributes:
53+
label: Bug Summary
54+
description: A clear and concise description of what the bug is and steps to reproduce the behavior.
55+
value: |
56+
**Describe the bug:**
57+
58+
**To Reproduce:**
59+
validations:
60+
required: true
61+
- type: textarea
62+
attributes:
63+
label: Expected behavior
64+
description: A clear and concise description of what you expected to happen.
65+
validations:
66+
required: true
67+
- type: textarea
68+
attributes:
69+
label: Any logs, error output, screenshots etc? Provide the devfile that sees this bug, if applicable
70+
description: |
71+
To get logs:
72+
ci: please copy the github workflow output
73+
api: please copy the terminal output
74+
library: please copy the terminal output
75+
registry: follow instruction under "Collecting Logs" to find log: https://github.com/devfile/registry-support/blob/main/TROUBLESHOOTING.md
76+
devworkspace: copy the logs from the controller (kubectl logs deploy/devworkspace-controller -n $NAMESPACE)
77+
test-automation:
78+
api: follow instruction under "Running tests locally" to find test log: https://github.com/devfile/api/tree/main/test
79+
library: follow instruction under "Running the tests locally" to find test log: https://github.com/devfile/library/tree/main/tests
80+
devworkspace: copy the logs from the controller (kubectl logs deploy/devworkspace-controller -n $NAMESPACE)
81+
integration-tests: please copy the build log under prow ci result for QE ingetration tests
82+
- type: textarea
83+
attributes:
84+
label: Additional context
85+
description: Add any other context about the problem here.
86+
- type: textarea
87+
attributes:
88+
label: Any workaround?
89+
description: Describe the workaround if applicable.
90+
- type: textarea
91+
attributes:
92+
label: Suggestion on how to fix the bug
93+
description: Provide suggestion on how to fix the bug upon your investigation, if applicable.

‎.github/ISSUE_TEMPLATE/2_user_story.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: User Story
2+
description: 📝 User story for new enhancement
3+
labels:
4+
- kind/user-story
5+
body:
6+
- type: dropdown
7+
attributes:
8+
label: Which area is this user story related to?
9+
description: Choose the area(s) this story is related to.
10+
multiple: true
11+
options:
12+
- /area ci
13+
- /area api
14+
- /area library
15+
- /area registry
16+
- /area registry-viewer
17+
- /area alizer
18+
- /area devworkspace
19+
- /area integration-tests
20+
- /area test-automation
21+
- /area releng
22+
- /area landing-page
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: User Story
28+
description: Describe the user, action, and intention of the story then a clear and concise description of what needs to be done to achieve this story.
29+
placeholder: As a ... I want to ..., so that ...
30+
value: As a ... I want to ..., so that ...
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Acceptance Criteria
36+
description: Decide which specific steps need to be completed, outline subtasks.
37+
value: |
38+
- [ ] ....
39+
- [ ] ....
40+
validations:
41+
required: true

‎.github/ISSUE_TEMPLATE/3_task.yml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Task
2+
description: 🔧 Issue for project support and quality assurance
3+
labels:
4+
- kind/task
5+
body:
6+
- type: dropdown
7+
attributes:
8+
label: Which area is this issue related to?
9+
description: Choose the area(s) this task is related to.
10+
multiple: true
11+
options:
12+
- /area ci
13+
- /area api
14+
- /area library
15+
- /area registry
16+
- /area registry-viewer
17+
- /area alizer
18+
- /area devworkspace
19+
- /area integration-tests
20+
- /area test-automation
21+
- /area releng
22+
- /area landing-page
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Issue Description
28+
description: A clear and concise description of what the task is.
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Acceptance Criteria
34+
description: Decide which specific steps need to be completed, outline subtasks.
35+
value: |
36+
- [ ] ....
37+
- [ ] ....
38+
- type: input
39+
attributes:
40+
label: Target Odo version
41+
description: Provide the target Odo version if this task is for QE integration test.
42+
value: 'Target Odo version: <odo-version>'

‎.github/ISSUE_TEMPLATE/4_feature_request.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Feature request
2+
description: 💡 Suggest an idea for this project
3+
labels:
4+
- kind/enhancement
5+
body:
6+
- type: dropdown
7+
attributes:
8+
label: Which area is this feature related to?
9+
description: Choose the area(s) this feature is related to.
10+
multiple: true
11+
options:
12+
- /area ci
13+
- /area api
14+
- /area library
15+
- /area registry
16+
- /area registry-viewer
17+
- /area alizer
18+
- /area devworkspace
19+
- /area integration-tests
20+
- /area test-automation
21+
- /area releng
22+
- /area landing-page
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Which functionality do you think we should add?
28+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
29+
value: |
30+
**Why is this needed? Is your feature request related to a problem?**
31+
32+
**Detailed description:**
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: Describe the solution you'd like
38+
description: A clear and concise description of what you want to happen.
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: Describe alternatives you've considered
44+
description: A clear and concise description of any alternative solutions or features you've considered.
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: Additional context
50+
description: Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/5_documentation.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Documentation
2+
description: 📖 Suggest an update for devfile documentation
3+
labels:
4+
- area/documentation
5+
body:
6+
- type: dropdown
7+
attributes:
8+
label: Which area is this documentation change related to?
9+
description: Choose the area(s) this documentation change refer to.
10+
multiple: true
11+
options:
12+
- /area ci
13+
- /area api
14+
- /area library
15+
- /area registry
16+
- /area registry-viewer
17+
- /area alizer
18+
- /area devworkspace
19+
- /area integration-tests
20+
- /area test-automation
21+
- /area releng
22+
- /area landing-page
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Issue details
28+
description: Provide a clear and concise description of the changes you are suggesting
29+
value: |
30+
**What mistake did you find / what is missing in the documentation?**
31+
validations:
32+
required: true

‎.github/ISSUE_TEMPLATE/6_registry_update.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Emergency registry update
2+
description: ⚠️ Request for an emergency registry update
3+
title: "[Maintenance]: Promote stack <name> changes to production"
4+
labels:
5+
- area/registry
6+
assignees:
7+
- michael-valdron
8+
body:
9+
- type: textarea
10+
attributes:
11+
label: Request details
12+
description: |
13+
The staging devfile registry, https://registry.stage.devfile.io is refreshed upon each commit to main in this repository.
14+
Production, https://registry.devfile.io, is promoted manually each Wednesday, as needed.
15+
16+
If you are a stack or sample owner and need to request an urgent refresh of https://registry.devfile.io before Wednesday (for example if a stack is broken),
17+
please fill out the issue template below.
18+
value: |
19+
**Stack name:**
20+
21+
**Why is the refresh needed:**
22+
23+
**Why the refresh cannot wait until the next regularly scheduled refresh:**
24+
validations:
25+
required: true

‎.github/ISSUE_TEMPLATE/7_epic.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Epic
2+
description: 📑 Issue for a large goal
3+
labels:
4+
- kind/epic
5+
body:
6+
- type: dropdown
7+
attributes:
8+
label: Which area is this epic related to?
9+
description: Choose the area(s) this epic is related to.
10+
multiple: true
11+
options:
12+
- /area ci
13+
- /area api
14+
- /area library
15+
- /area registry
16+
- /area registry-viewer
17+
- /area alizer
18+
- /area devworkspace
19+
- /area integration-tests
20+
- /area test-automation
21+
- /area releng
22+
- /area landing-page
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Epic Story
28+
description: A clear and concise description of what needs to be done to achieve this goal.
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Acceptance Criteria
34+
description: Decide which specific steps need to be completed, outline subtasks/child issues.
35+
value: |
36+
- [ ] ....
37+
- [ ] ....
38+
validations:
39+
required: true

0 commit comments

Comments
 (0)