Skip to content

Commit

Permalink
Change issue templates to forms (#2602)
Browse files Browse the repository at this point in the history
  • Loading branch information
emdneto committed Jun 12, 2024
1 parent da78275 commit 184d8d4
Show file tree
Hide file tree
Showing 5 changed files with 120 additions and 38 deletions.
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
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-contrib/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug) to see if your bug is already addressed.
- 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)
Package version: (e.g., 0.46.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) if possible and the needed steps to reproduce the problem.
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-contrib/blob/main/CONTRIBUTING.md).
options:
- "No"
- "Yes"
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
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.
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
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: What problem do you want to solve?
description: Is your feature request related to a problem? If so, provide a concise description of the problem.
placeholder: Describe the problem and include relevant issue IDs
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-contrib/blob/main/CONTRIBUTING.md).
options:
- "No"
- "Yes"

0 comments on commit 184d8d4

Please sign in to comment.