Skip to content

Commit ba22b16

Browse files
emdnetolzchen
andauthored
Change issue templates to forms (#3951)
* first draft of issue forms * texts in long lines and split description form * fix yaml * add os to environment section * remove some fields from bug report * add sdk and api version as example --------- Co-authored-by: Leighton Chen <[email protected]>
1 parent c5b0244 commit ba22b16

File tree

5 files changed

+122
-38
lines changed

5 files changed

+122
-38
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

-19
This file was deleted.
+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
name: Bug Report
3+
description: Create a report to help us improve
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
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.
10+
11+
Before filing a bug, please be sure you have searched through [existing bugs](https://github.com/open-telemetry/opentelemetry-python/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug) to see if your bug is already addressed.
12+
If your bug is related to an instrumentation or plugin in [opentelemetry-python-contrib](https://github.com/open-telemetry/opentelemetry-python-contrib) please be sure to file it there.
13+
14+
- type: textarea
15+
id: environment
16+
attributes:
17+
label: Describe your environment
18+
description: |
19+
Please describe any aspect of your environment relevant to the problem, including your Python version, [platform](https://docs.python.org/3/library/platform.html), version numbers of installed dependencies, information about your cloud hosting provider, etc. If you're reporting a problem with a specific version of a library in this repo, please check whether the problem has been fixed on main.
20+
value: |
21+
OS: (e.g, Ubuntu)
22+
Python version: (e.g., Python 3.8.10)
23+
SDK version: (e.g., 1.25.0)
24+
API version: (e.g., 1.25.0)
25+
26+
- type: textarea
27+
attributes:
28+
label: What happened?
29+
description: Please provide as much detail as you reasonably can.
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
attributes:
35+
label: Steps to Reproduce
36+
description: Provide a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). We will close the issue if the repro project you share with us is complex or we cannot reproduce the behavior you are reporting. We cannot investigate custom projects, so don't point us to such, please.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
attributes:
42+
label: Expected Result
43+
description: What did you expect to see?
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
attributes:
49+
label: Actual Result
50+
description: What did you see instead?
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: additional-context
56+
attributes:
57+
label: Additional context
58+
description: Add any other context about the problem here.
59+
placeholder: Any additional information...
60+
61+
- type: dropdown
62+
id: contribute
63+
attributes:
64+
label: Would you like to implement a fix?
65+
description: For guidance on how to get started, refer to the [contribution guide](https://github.com/open-telemetry/opentelemetry-python/blob/main/CONTRIBUTING.md).
66+
options:
67+
- "No"
68+
- "Yes"

.github/ISSUE_TEMPLATE/config.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: Slack
3+
url: https://cloud-native.slack.com/archives/C01PD4HUVBL
4+
about: Or the `#otel-python` channel in the CNCF Slack instance.

.github/ISSUE_TEMPLATE/feature_request.md

-19
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: Feature Request
3+
description: Suggest an idea for this project
4+
labels: [feature-request]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Before opening a feature request against this repo, consider whether the feature should/could be implemented in the [other OpenTelemetry client libraries](https://github.com/open-telemetry/). If so, please [open an issue on opentelemetry-specification](https://github.com/open-telemetry/opentelemetry-specification/issues/new) first.
10+
- type: textarea
11+
id: related-problem
12+
attributes:
13+
label: Is your feature request related to a problem?
14+
description: Is your feature request related to a problem? If so, provide a concise description of the problem.
15+
placeholder: Include the Issue ID from this or other repos.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: solution
20+
attributes:
21+
label: Describe the solution you'd like
22+
description: What do you want to happen instead? What is the expected behavior?
23+
placeholder: I'd like to ...
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Describe alternatives you've considered
30+
description: Which alternative solutions or features have you considered?
31+
placeholder: Some potential solutions
32+
validations:
33+
required: false
34+
- type: textarea
35+
id: additional-context
36+
attributes:
37+
label: Additional Context
38+
description: Add any other context about the feature request here.
39+
placeholder: Some related requests in other projects or upstream spec proposals.
40+
validations:
41+
required: false
42+
- type: dropdown
43+
id: contribute
44+
attributes:
45+
label: Would you like to implement a fix?
46+
description: |
47+
For guidance on how to get started, refer to the [contribution guide](https://github.com/open-telemetry/opentelemetry-python/blob/main/CONTRIBUTING.md).
48+
options:
49+
- "No"
50+
- "Yes"

0 commit comments

Comments
 (0)