Skip to content

Commit cde92db

Browse files
fabianburthsk31337
andauthored
chore: update issue templates (#84)
<!-- markdownlint-disable MD041 --> #### What this PR does / why we need it We noticed that we need a lot of roundtrips on bug reports with our users to get all the information we need to identify and reproduce their bugs. We hope to be able to reduce those roundtrips by providing a more verbose description of what we expect in our issue template. Besides, we remove the issue templates merely used for our project management from these issue templates (that are propagated to all our repositories). Instead, we will add them only to `ocm-project`. #### Which issue(s) this PR is related to <!-- Usage: `Related to #<issue number>`, or `Related to (paste link of issue)`. --> --------- Signed-off-by: Fabian Burth <[email protected]> Co-authored-by: Steffen <[email protected]>
1 parent 4c07545 commit cde92db

File tree

5 files changed

+42
-81
lines changed

5 files changed

+42
-81
lines changed

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,50 @@ assignees: ''
88
---
99

1010
**Context**
11-
A clear and concise description of what the bug is.
11+
<!---
12+
Please provide a clear and concise description of the bug.
13+
-->
1214

1315
**Version**
14-
v0.20.0
16+
<!---
17+
Please provide the version of the project are you using?
18+
- For ocm-cli, run `ocm --version`.
19+
- For ocm-controllers, check the image specified in your deployment.
20+
-->
1521

1622
**To Reproduce**
17-
Steps to reproduce the behavior:
18-
23+
<!---
24+
Please provide steps to reproduce the behavior. Keep the description as
25+
minimal and precisely as possible!
26+
The listed information below is intended as guidance, please include only as
27+
much as required to reproduce.
28+
29+
- For the ocm-cli, provide information about
30+
- the environment you are running on (OS, shell, etc.),
31+
- the commands (including flags) you used,
32+
- the relevant parts of your configuration file (default location `$HOME/.
33+
ocmconfig`). Be careful to redact any sensitive information.
34+
35+
- For the ocm-controllers, provide information about
36+
- the relevant kubernetes resource manifests
37+
- the relevant ocm components and artifacts (an overview can be provided
38+
by `ocm get cv ... -r` and `ocm get resources ... -r`)
39+
- the relevant controller logs
40+
- the cluster infrastructure you are running on (like kind)
41+
- the kubernetes/kro/flux version
42+
-->
1943

2044
**Actual behavior**
21-
A clear and concise description of what is happening.
45+
<!---
46+
Please provide a clear and concise description of what actually happened.
47+
-->
2248

2349
**Expected behavior**
24-
A clear and concise description of what you expected to happen.
25-
26-
**Screenshots (optional)**
27-
If applicable, add screenshots to help explain your problem.
28-
29-
**Environment**
30-
- [ ] windows
31-
- [ ] linux
32-
- [x] mac
50+
<!---
51+
Please provide a clear and concise description of what you expected to happen.
52+
-->
3353

3454
**Additional Comments**
35-
Any observation, gut feeling or other information you think help the community to troubleshoot the problem?
55+
<!---
56+
Is there any other information we need to know about this bug?
57+
-->

.github/ISSUE_TEMPLATE/epic.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,8 @@ labels: kind/feature
77
---
88

99
**Description**
10-
What would you like to be added? Why is this needed?
10+
<!---
11+
What would you like to be added?
12+
Why is this needed?
13+
-->
14+

.github/ISSUE_TEMPLATE/spike.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/task.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)