Skip to content

Commit c4ba855

Browse files
authored
[chore] Add issue templates (#2206)
* add issue templates * add pr template
1 parent 4be529c commit c4ba855

File tree

4 files changed

+140
-0
lines changed

4 files changed

+140
-0
lines changed
+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: ["bug", "needs triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report! Please make sure to fill out the entire form below, providing as much context as you can in order to help us triage and track down your bug as quickly as possible.
9+
10+
Before filing a bug, please be sure you have searched through [existing bugs](https://github.com/open-telemetry/opentelemetry-operator/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug) to see if an existing issue covers your bug.
11+
- type: dropdown
12+
id: component
13+
attributes:
14+
label: Component(s)
15+
description: Which component(s) does your bug report concern?
16+
multiple: true
17+
options:
18+
- operator
19+
- collector
20+
- instrumentation
21+
- target allocator
22+
- opamp bridge
23+
- type: textarea
24+
attributes:
25+
label: What happened?
26+
description: Please provide as much detail as you reasonably can.
27+
value: |
28+
## Description
29+
30+
## Steps to Reproduce
31+
32+
## Expected Result
33+
34+
## Actual Result
35+
36+
validations:
37+
required: true
38+
- type: input
39+
attributes:
40+
label: Kubernetes Version
41+
description: What version did you use? (e.g., `1.23.0`)
42+
validations:
43+
required: true
44+
- type: input
45+
attributes:
46+
label: Operator version
47+
description: What version did you use? (e.g., `v0.4.0`, `1eb551b`, etc)
48+
validations:
49+
required: true
50+
- type: input
51+
attributes:
52+
label: Collector version
53+
description: What version did you use? (e.g., `v0.4.0`, `1eb551b`, etc)
54+
validations:
55+
required: true
56+
- type: textarea
57+
attributes:
58+
label: Environment information
59+
description: Please provide any additional information about your installation.
60+
value: |
61+
## Environment
62+
OS: (e.g., "Ubuntu 20.04")
63+
Compiler(if manually compiled): (e.g., "go 14.2")
64+
- type: textarea
65+
attributes:
66+
label: Log output
67+
description: |
68+
Please copy and paste any relevant log output.
69+
render: shell
70+
- type: textarea
71+
attributes:
72+
label: Additional context
73+
description: Any additional information you think may be relevant to this issue.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: ["enhancement", "needs triage"]
4+
body:
5+
- type: dropdown
6+
id: component
7+
attributes:
8+
label: Component(s)
9+
description: Which component(s) does your feature request concern?
10+
multiple: true
11+
options:
12+
- operator
13+
- collector
14+
- instrumentation
15+
- target allocator
16+
- opamp bridge
17+
- type: textarea
18+
attributes:
19+
label: Is your feature request related to a problem? Please describe.
20+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Describe the solution you'd like
26+
description: A clear and concise description of what you want to happen.
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: Describe alternatives you've considered
32+
description: A clear and concise description of any alternative solutions or features you've considered.
33+
- type: textarea
34+
attributes:
35+
label: Additional context
36+
description: Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/other.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Other issue
2+
description: Create a new issue to help us improve the operator
3+
labels: ["needs triage"]
4+
body:
5+
- type: dropdown
6+
id: component
7+
attributes:
8+
label: Component(s)
9+
description: Which component(s) does your issue concern?
10+
multiple: true
11+
options:
12+
- operator
13+
- collector
14+
- instrumentation
15+
- target allocator
16+
- opamp bridge
17+
- type: textarea
18+
attributes:
19+
label: Describe the issue you're reporting
20+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
21+
validations:
22+
required: true

.github/pull_request_template.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
**Description:** <Describe what has changed.>
2+
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
3+
Ex. Adding a feature - Explain what this achieves.-->
4+
5+
**Link to tracking Issue:** <Issue number if applicable>
6+
7+
**Testing:** <Describe what testing was performed and which tests were added.>
8+
9+
**Documentation:** <Describe the documentation added.>

0 commit comments

Comments
 (0)