-
Notifications
You must be signed in to change notification settings - Fork 652
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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]>
- Loading branch information
Showing
5 changed files
with
122 additions
and
38 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
name: Bug Report | ||
description: Create a report to help us improve | ||
labels: [bug] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
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. | ||
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. | ||
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. | ||
- type: textarea | ||
id: environment | ||
attributes: | ||
label: Describe your environment | ||
description: | | ||
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. | ||
value: | | ||
OS: (e.g, Ubuntu) | ||
Python version: (e.g., Python 3.8.10) | ||
SDK version: (e.g., 1.25.0) | ||
API version: (e.g., 1.25.0) | ||
- type: textarea | ||
attributes: | ||
label: What happened? | ||
description: Please provide as much detail as you reasonably can. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Steps to Reproduce | ||
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. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Expected Result | ||
description: What did you expect to see? | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Actual Result | ||
description: What did you see instead? | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Add any other context about the problem here. | ||
placeholder: Any additional information... | ||
|
||
- type: dropdown | ||
id: contribute | ||
attributes: | ||
label: Would you like to implement a fix? | ||
description: For guidance on how to get started, refer to the [contribution guide](https://github.com/open-telemetry/opentelemetry-python/blob/main/CONTRIBUTING.md). | ||
options: | ||
- "No" | ||
- "Yes" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
contact_links: | ||
- name: Slack | ||
url: https://cloud-native.slack.com/archives/C01PD4HUVBL | ||
about: Or the `#otel-python` channel in the CNCF Slack instance. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
name: Feature Request | ||
description: Suggest an idea for this project | ||
labels: [feature-request] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
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. | ||
- type: textarea | ||
id: related-problem | ||
attributes: | ||
label: Is your feature request related to a problem? | ||
description: Is your feature request related to a problem? If so, provide a concise description of the problem. | ||
placeholder: Include the Issue ID from this or other repos. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: Describe the solution you'd like | ||
description: What do you want to happen instead? What is the expected behavior? | ||
placeholder: I'd like to ... | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: alternatives | ||
attributes: | ||
label: Describe alternatives you've considered | ||
description: Which alternative solutions or features have you considered? | ||
placeholder: Some potential solutions | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional Context | ||
description: Add any other context about the feature request here. | ||
placeholder: Some related requests in other projects or upstream spec proposals. | ||
validations: | ||
required: false | ||
- type: dropdown | ||
id: contribute | ||
attributes: | ||
label: Would you like to implement a fix? | ||
description: | | ||
For guidance on how to get started, refer to the [contribution guide](https://github.com/open-telemetry/opentelemetry-python/blob/main/CONTRIBUTING.md). | ||
options: | ||
- "No" | ||
- "Yes" |