-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* more * commented * yml * Add an issue template for API proposals * Update .github/ISSUE_TEMPLATE/api-proposal.md Co-authored-by: Stephen Toub <[email protected]> * Update .github/ISSUE_TEMPLATE/api-proposal.md Co-authored-by: Stephen Toub <[email protected]> * Update .github/ISSUE_TEMPLATE/api-proposal.md Co-authored-by: Stephen Toub <[email protected]> * comment out template instructions * apply consistent naming * feedback * add blank * H2 and H3 Co-authored-by: Eirik Tsarpalis <[email protected]> Co-authored-by: Stephen Toub <[email protected]>
- Loading branch information
1 parent
858642d
commit 4e140f4
Showing
5 changed files
with
171 additions
and
0 deletions.
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. | ||
* 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. | ||
--> |