Update issue/pr templates (#1165)

* update issue template to prepare for Beta-2

* update PR template

* improve consistency

* address review comments

Co-authored-by: Cijo Thomas <cithomas@microsoft.com>
This commit is contained in:
Reiley Yang 2020-08-25 16:23:47 -07:00 committed by GitHub
parent c7e6c89e21
commit cdc19f9ce4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 53 additions and 16 deletions

View File

@ -4,21 +4,41 @@ about: Create a report to help us improve
labels: bug
---
**Describe your environment.** Describe any aspect of your environment relevant to the problem:
* SDK version: (nuget versions of the all the relevant packages)
* .NET runtime version (.NET or .NET Core, TargetFramework in the .csproj file):
* Platform and OS version:
# Bug Report
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 master.
List of [NuGet packages](https://www.nuget.org/profiles/OpenTelemetry) and
version that you are using (e.g. `OpenTelemetry 0.4.0-beta.2`):
**Steps to reproduce.**
Describe exactly how to reproduce the error. Include a code sample if applicable.
*
Runtime version (e.g. `net461`, `net48`, `netcoreapp2.1`, `netcoreapp3.1`, etc.
You can find this information from the `*.csproj` file):
*
## Symptom
A clear and concise description of what the bug is.
**What is the expected behavior?**
What did you expect to see?
**What is the actual behavior?**
What did you see instead?
**Additional context.**
## Reproduce
Create a self-contained project using the template of your choice, apply the
minimum required code to result in the issue you're observing.
We will close this issue if:
* The repro project you share with us is complex. We can't investigate custom
projects, so don't point us to such, please.
* If we can not reproduce the behavior you're reporting.
## Additional Context
Add any other context about the problem here.

View File

@ -4,16 +4,26 @@ about: Suggest an idea for this project
labels: enhancement
---
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.
# Feature Request
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.
**Is your feature request related to a problem?**
If so, provide a concise description of the problem.
**Describe the solution you'd like.**
**Describe the solution you'd like:**
What do you want to happen instead? What is the expected behavior?
**Describe alternatives you've considered.**
Which alternative solutions or features have you considered?
**Additional context.**
## Additional Context
Add any other context about the feature request here.

View File

@ -4,10 +4,17 @@ about: Create a question to help us improve our knowledgebase and documentation
labels: question
---
**Describe your environment.** Describe any aspect of your environment relevant to the question:
# Question
**Describe your environment.**
Describe any aspect of your environment relevant to the question.
**What are you trying to achieve?**
What did you expect to see?
**Additional context.**
Add any other context about the problem here. If you followed an existing documentation, please share the link to it.
## Additional Context
Add any other context about the problem here. If you followed an existing
documentation, please share the link to it.

View File

@ -2,10 +2,10 @@ Fixes #.
## Changes
Please provide a brief description of the changes here. Update the
`CHANGELOG.md` for non-trivial changes.
Please provide a brief description of the changes here.
For significant contributions please make sure you have completed the following items:
* [ ] `CHANGELOG.md` updated for non-trivial changes
* [ ] Design discussion issue #
* [ ] Changes in public API reviewed