-
Notifications
You must be signed in to change notification settings - Fork 4.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add issue templates #36431
Merged
Merged
Add issue templates #36431
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
ef94b92
more
danmoseley 3cd9765
commented
danmoseley 1afe7ca
yml
danmoseley fe998c6
Add an issue template for API proposals
eiriktsarpalis 9e6d294
Update .github/ISSUE_TEMPLATE/api-proposal.md
eiriktsarpalis 2a160ae
Update .github/ISSUE_TEMPLATE/api-proposal.md
eiriktsarpalis 1541004
Update .github/ISSUE_TEMPLATE/api-proposal.md
eiriktsarpalis d5da3fc
comment out template instructions
eiriktsarpalis 3e98cda
apply consistent naming
eiriktsarpalis 8564cf9
feedback
danmoseley 9a243c0
add blank
danmoseley f12c7ff
H2 and H3
danmoseley File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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,52 @@ | ||
--- | ||
name: API Proposal | ||
about: Propose a change to the public API surface. | ||
title: '' | ||
labels: api-suggestion | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Background and Motivation | ||
|
||
<!-- | ||
We welcome API proposals! We have a process to evaluate the value and shape of new API. There is an overview of our process [here](https://github.com/dotnet/runtime/blob/master/docs/project/api-review-process.md). This template will help us gather the information we need to start the review process. | ||
First, please describe the purpose and value of the new API here. | ||
--> | ||
|
||
## Proposed API | ||
|
||
<!-- | ||
Please provide the specific public API signature diff that you are proposing. For example: | ||
```diff | ||
namespace System.Collections.Generic | ||
{ | ||
- public class HashSet<T> : ICollection<T>, ISet<T> { | ||
+ public class HashSet<T> : ICollection<T>, ISet<T>, IReadOnlySet<T> { | ||
} | ||
``` | ||
You may find the [Framework Design Guidelines](https://github.com/dotnet/runtime/blob/master/docs/coding-guidelines/framework-design-guidelines-digest.md) helpful. | ||
--> | ||
|
||
## Usage Examples | ||
|
||
<!-- | ||
Please provide code examples that highlight how the proposed API additions are meant to be consumed. | ||
This will help suggest whether the API has the right shape to be functional, performant and useable. | ||
You can use code blocks like this: | ||
``` C# | ||
// some lines of code here | ||
``` | ||
--> | ||
|
||
## Alternative Designs | ||
|
||
<!-- | ||
Were there other options you considered, such as alternative API shapes? | ||
--> | ||
|
||
## Risks | ||
|
||
<!-- | ||
Please mention any risks that to your knowledge the API proposal might entail, such as breaking changes, performance regressions, etc. | ||
--> |
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,8 @@ | ||
--- | ||
name: Blank | ||
about: Something that doesn't fit the other categories | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- |
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,41 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!--This is just a template - feel free to delete any and all of it and replace as appropriate.--> | ||
|
||
### Description | ||
|
||
<!-- | ||
* Please share a clear and concise description of the problem. | ||
* Include minimal steps to reproduce the problem if possible. E.g.: the smallest possible code snippet; or a small repo to clone, with steps to run it. | ||
* What behavior are you seeing, and what behavior would you expect? | ||
--> | ||
|
||
### Configuration | ||
|
||
<!-- | ||
* Which version of .NET is the code running on? | ||
* What OS and version, and what distro if applicable? | ||
* What is the architecture (x64, x86, ARM, ARM64)? | ||
* Do you know whether it is specific to that configuration? | ||
--> | ||
|
||
### Regression? | ||
|
||
<!-- | ||
* Did this work in a previous build or release of .NET Core, or from .NET Framework? If you can try a previous release or build to find out, that can help us narrow down the problem. If you don't know, that's OK. | ||
--> | ||
|
||
### Other information | ||
|
||
<!-- | ||
* Please include any relevant stack traces or error messages. If possible please include text as text rather than images (so it shows up in searches). | ||
* If you have an idea where the problem might lie, let us know that here. Please include any pointers to code, relevant changes, or related issues you know of. | ||
danmoseley marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* Do you know of any workarounds? | ||
--> |
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,20 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Issue with ASP.NET Core | ||
url: https://github.com/dotnet/aspnetcore/issues/new/choose | ||
about: Please open issues with ASP.NET Core in their repo | ||
- name: Issue with .NET Core SDK | ||
url: https://github.com/dotnet/sdk/issues/new/choose | ||
about: Please open issues with the .NET Core SDK in their repo | ||
- name: Issue with Entity Framework | ||
url: https://github.com/dotnet/efcore/issues/new/choose | ||
about: Please open issues with Entity Framework in their repo | ||
- name: Issue with Roslyn compiler | ||
url: https://github.com/dotnet/roslyn/issues/new/choose | ||
about: Please open issues with the Roslyn compiler in their repo | ||
- name: Issue with Windows Forms | ||
url: https://github.com/dotnet/winforms/issues/new/choose | ||
about: Please open issues with Windows Forms in their repo | ||
- name: Issue with WPF | ||
url: https://github.com/dotnet/wpf/issues/new/choose | ||
about: Please open issues with WPF in their repo |
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: Performance issue | ||
about: Report a performance problem or regression | ||
title: '' | ||
labels: 'tenet-performance' | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!--This is just a template - feel free to delete any and all of it and replace as appropriate.--> | ||
|
||
### Description | ||
|
||
<!-- | ||
* Please share a clear and concise description of the performance problem. | ||
* Include minimal steps to reproduce the problem if possible. E.g.: the smallest possible code snippet; or a small repo to clone, with steps to run it. | ||
--> | ||
|
||
### Configuration | ||
|
||
<!-- | ||
(If you are posting Benchmark.NET results, this info will be included.) | ||
* Which version of .NET is the code running on? | ||
* What OS version, and what distro if applicable? | ||
* What is the architecture (x64, x86, ARM, ARM64)? | ||
* If relevant, what are the specs of the machine? | ||
--> | ||
|
||
### Regression? | ||
|
||
<!-- | ||
* Is this a regression from a previous build or release of .NET Core, or from .NET Framework? If you can try a previous release or build to find out, that can help us narrow down the problem. If you don't know, that's OK. | ||
--> | ||
|
||
### Data | ||
|
||
<!-- | ||
* Please include any benchmark results, images of graphs, timings or measurements, or callstacks that are relevant. | ||
* If possible please include text as text rather than images (so it shows up in searches). | ||
* If applicable please include before and after measurements. | ||
* There is helpful information about measuring code in this repo [here](https://github.com/dotnet/performance/blob/master/docs/benchmarking-workflow-dotnet-runtime.md). | ||
--> | ||
|
||
### Analysis | ||
|
||
<!-- | ||
* If you have an idea where the problem might lie, let us know that here. | ||
* Please include any pointers to code, relevant changes, or related issues you know of. | ||
* If you don't know, you can delete this section. | ||
--> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it make sense to automatically assign the 'bug' label on these issues? Or should this happen after triage?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, we would probably want a separate "feature request" template in that case (not all features add API)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps I should have a "blank template" as well, for such things.