Skip to content

Commit 22851c4

Browse files
michael-valdronJdubrick
michael-valdron
and
Jdubrick
authored
Create GitHub Issue Forms (#1703)
* github issue forms Signed-off-by: Michael Valdron <[email protected]> * change areas dropdown to textarea due to technical limitation Signed-off-by: Michael Valdron <[email protected]> * add documentation area under epic area choices Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/1_bug_report.yml Bug Report Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/1_bug_report.yml Choose and fill in the applicable sections. Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/1_bug_report.yml Go Project Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/1_bug_report.yml Node.js Project Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/1_bug_report.yml Web Browser Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/3_task.yml Target Odo Version Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/1_bug_report.yml Expected Behavior Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/1_bug_report.yml Additional Context Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/4_feature_request.yml Feature Request Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/4_feature_request.yml Additional Context Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/5_documentation.yml Issue Details Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/6_registry_update.yml Emergency Registry Update Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * Update .github/ISSUE_TEMPLATE/6_registry_update.yml Request Details Co-authored-by: Jordan Dubrick <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * review feedback: add Task Assignee field to registry update issue type with devfile/devfile-registry-maintainers as the default value Signed-off-by: Michael Valdron <[email protected]> * review feedback: use markdown comments instead of quotes for areas default Signed-off-by: Michael Valdron <[email protected]> --------- Signed-off-by: Michael Valdron <[email protected]> Co-authored-by: Jordan Dubrick <[email protected]>
1 parent 5c3d7b9 commit 22851c4

File tree

13 files changed

+404
-347
lines changed

13 files changed

+404
-347
lines changed

‎.github/ISSUE_TEMPLATE/1_bug_report.yml‎

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

‎.github/ISSUE_TEMPLATE/2_user_story.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: User Story
2+
description: 📝 User story for new enhancement
3+
labels:
4+
- kind/user-story
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Which area is this user story related to?
9+
description: Choose the area(s) this story is related to.
10+
value: |
11+
<!--- Uncomment the area(s) this feature is related to --->
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+
placeholder: |
24+
/area ci
25+
/area api
26+
/area library
27+
/area registry
28+
/area registry-viewer
29+
/area alizer
30+
/area devworkspace
31+
/area integration-tests
32+
/area test-automation
33+
/area releng
34+
/area landing-page
35+
validations:
36+
required: true
37+
- type: textarea
38+
attributes:
39+
label: User Story
40+
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.
41+
placeholder: As a ... I want to ..., so that ...
42+
value: As a ... I want to ..., so that ...
43+
validations:
44+
required: true
45+
- type: textarea
46+
attributes:
47+
label: Acceptance Criteria
48+
description: Decide which specific steps need to be completed, outline subtasks.
49+
value: |
50+
- [ ] ....
51+
- [ ] ....
52+
validations:
53+
required: true

‎.github/ISSUE_TEMPLATE/3_task.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Task
2+
description: 🔧 Issue for project support and quality assurance
3+
labels:
4+
- kind/task
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Which area is this issue related to?
9+
description: Choose the area(s) this task is related to.
10+
value: |
11+
<!--- Uncomment the area(s) this feature is related to --->
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+
placeholder: |
24+
/area ci
25+
/area api
26+
/area library
27+
/area registry
28+
/area registry-viewer
29+
/area alizer
30+
/area devworkspace
31+
/area integration-tests
32+
/area test-automation
33+
/area releng
34+
/area landing-page
35+
validations:
36+
required: true
37+
- type: textarea
38+
attributes:
39+
label: Issue Description
40+
description: A clear and concise description of what the task is.
41+
validations:
42+
required: true
43+
- type: textarea
44+
attributes:
45+
label: Acceptance Criteria
46+
description: Decide which specific steps need to be completed, outline subtasks.
47+
value: |
48+
- [ ] ....
49+
- [ ] ....
50+
- type: input
51+
attributes:
52+
label: Target Odo Version
53+
description: Provide the target Odo version if this task is for QE integration test.
54+
value: 'Target Odo version: <odo-version>'

‎.github/ISSUE_TEMPLATE/4_feature_request.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Feature Request
2+
description: 💡 Suggest an idea for this project
3+
labels:
4+
- kind/enhancement
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Which area is this feature related to?
9+
description: Choose the area(s) this feature is related to.
10+
value: |
11+
<!--- Uncomment the area(s) this feature is related to --->
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+
placeholder: |
24+
/area ci
25+
/area api
26+
/area library
27+
/area registry
28+
/area registry-viewer
29+
/area alizer
30+
/area devworkspace
31+
/area integration-tests
32+
/area test-automation
33+
/area releng
34+
/area landing-page
35+
validations:
36+
required: true
37+
- type: textarea
38+
attributes:
39+
label: Which functionality do you think we should add?
40+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
41+
value: |
42+
**Why is this needed? Is your feature request related to a problem?**
43+
44+
**Detailed description:**
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: Describe the solution you'd like
50+
description: A clear and concise description of what you want to happen.
51+
validations:
52+
required: true
53+
- type: textarea
54+
attributes:
55+
label: Describe alternatives you've considered
56+
description: A clear and concise description of any alternative solutions or features you've considered.
57+
validations:
58+
required: true
59+
- type: textarea
60+
attributes:
61+
label: Additional Context
62+
description: Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/5_documentation.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Documentation
2+
description: 📖 Suggest an update for devfile documentation
3+
labels:
4+
- area/documentation
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Which area is this documentation change related to?
9+
description: Choose the area(s) this documentation change refer to.
10+
value: |
11+
<!--- Uncomment the area(s) this feature is related to --->
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+
placeholder: |
24+
/area ci
25+
/area api
26+
/area library
27+
/area registry
28+
/area registry-viewer
29+
/area alizer
30+
/area devworkspace
31+
/area integration-tests
32+
/area test-automation
33+
/area releng
34+
/area landing-page
35+
validations:
36+
required: true
37+
- type: textarea
38+
attributes:
39+
label: Issue Details
40+
description: Provide a clear and concise description of the changes you are suggesting
41+
value: |
42+
**What mistake did you find / what is missing in the documentation?**
43+
validations:
44+
required: true

‎.github/ISSUE_TEMPLATE/6_registry_update.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
body:
7+
- type: input
8+
attributes:
9+
label: Task Assignee
10+
description: |
11+
The assignee for the task of updating the stack in question. Usually should be devfile/devfile-registry-maintainers
12+
unless otherwise specified.
13+
placeholder: '@devfile/devfile-registry-maintainers'
14+
value: '@devfile/devfile-registry-maintainers'
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Request Details
20+
description: |
21+
The staging devfile registry, https://registry.stage.devfile.io is refreshed upon each commit to main in this repository.
22+
Production, https://registry.devfile.io, is promoted manually each Wednesday, as needed.
23+
24+
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),
25+
please fill out the issue template below.
26+
value: |
27+
**Stack name:**
28+
29+
**Why is the refresh needed:**
30+
31+
**Why the refresh cannot wait until the next regularly scheduled refresh:**
32+
validations:
33+
required: true

0 commit comments

Comments
 (0)