From ef94b92ef13d834c9fd0ac934613e9dedbcec132 Mon Sep 17 00:00:00 2001 From: Dan Moseley Date: Wed, 13 May 2020 20:04:04 -0700 Subject: [PATCH 01/12] more --- .github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++++++++++++ .github/ISSUE_TEMPLATE/performance_issue.md | 35 +++++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/performance_issue.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000000..5c1bfbe0c02dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +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 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. diff --git a/.github/ISSUE_TEMPLATE/performance_issue.md b/.github/ISSUE_TEMPLATE/performance_issue.md new file mode 100644 index 0000000000000..35aa3573f4856 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/performance_issue.md @@ -0,0 +1,35 @@ +--- +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, that's OK. From 3cd97653e82c637fb481fb6579a6205be2a150b8 Mon Sep 17 00:00:00 2001 From: Dan Moseley Date: Wed, 13 May 2020 20:18:10 -0700 Subject: [PATCH 02/12] commented --- .github/ISSUE_TEMPLATE/bug_report.md | 10 +++++++++- .github/ISSUE_TEMPLATE/performance_issue.md | 12 +++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 5c1bfbe0c02dd..56faaf2643fb9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,22 +7,30 @@ assignees: '' --- -This is just a template - feel free to delete any and all of it and replace as appropriate. + **Description** + **Configuration** + **Regression?** + **Other information** + diff --git a/.github/ISSUE_TEMPLATE/performance_issue.md b/.github/ISSUE_TEMPLATE/performance_issue.md index 35aa3573f4856..2b325267aaf50 100644 --- a/.github/ISSUE_TEMPLATE/performance_issue.md +++ b/.github/ISSUE_TEMPLATE/performance_issue.md @@ -7,29 +7,39 @@ assignees: '' --- -This is just a template - feel free to delete any and all of it and replace as appropriate. + **Description** + **Configuration** + **Regression?** + **Data** + **Analysis** + From 1afe7ca53115f5739b1ae7f18da0fe1bbdfd1daa Mon Sep 17 00:00:00 2001 From: Dan Moseley Date: Wed, 13 May 2020 21:11:25 -0700 Subject: [PATCH 03/12] yml --- .github/ISSUE_TEMPLATE/config.yml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000000..4b38bcf921191 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 From fe998c647b574331b7b08c13dcb44d9625403ae9 Mon Sep 17 00:00:00 2001 From: Eirik Tsarpalis Date: Wed, 13 May 2020 12:49:58 +0100 Subject: [PATCH 04/12] Add an issue template for API proposals --- .github/ISSUE_TEMPLATE/api-proposal.md | 31 ++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/api-proposal.md diff --git a/.github/ISSUE_TEMPLATE/api-proposal.md b/.github/ISSUE_TEMPLATE/api-proposal.md new file mode 100644 index 0000000000000..b36088a8a6270 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/api-proposal.md @@ -0,0 +1,31 @@ +--- +name: API Proposal +about: Propose a change to the public API surface. +title: "[API Proposal] Your title goes here" +labels: api-suggestion +assignees: '' + +--- + +# Background and Motivation + +Please provide a thorough explanation of what might necessitate a change to the current APIs. + +# Proposed API + +Please provide the precise public API signature diff that you are proposing. If modifying existing API signatures this should be expressed using diff blocks, for example +```diff +namespace System.Collections.Generic +{ +- public class HashSet : ICollection, ISet { ++ public class HashSet : ICollection, ISet, IReadOnlySet { + } +``` + +# Usage Examples + +Please provide code examples that highlight how the proposed API changes are meant to be consumed. + +# Risks + +Please mention any risks that to your knowledge the API proposal might entail, such as breaking changes, performance regressions, etc. From 9e6d294ad4eb0ada2c570cdf35a7cbec59adf184 Mon Sep 17 00:00:00 2001 From: Eirik Tsarpalis Date: Wed, 13 May 2020 16:46:22 +0100 Subject: [PATCH 05/12] Update .github/ISSUE_TEMPLATE/api-proposal.md Co-authored-by: Stephen Toub --- .github/ISSUE_TEMPLATE/api-proposal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/api-proposal.md b/.github/ISSUE_TEMPLATE/api-proposal.md index b36088a8a6270..90f10fe9e695e 100644 --- a/.github/ISSUE_TEMPLATE/api-proposal.md +++ b/.github/ISSUE_TEMPLATE/api-proposal.md @@ -9,7 +9,7 @@ assignees: '' # Background and Motivation -Please provide a thorough explanation of what might necessitate a change to the current APIs. +Please provide a thorough explanation of what necessitates the additional API. # Proposed API From 2a160ae5ba22714e7fadbd884076f597314a8faf Mon Sep 17 00:00:00 2001 From: Eirik Tsarpalis Date: Wed, 13 May 2020 16:46:38 +0100 Subject: [PATCH 06/12] Update .github/ISSUE_TEMPLATE/api-proposal.md Co-authored-by: Stephen Toub --- .github/ISSUE_TEMPLATE/api-proposal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/api-proposal.md b/.github/ISSUE_TEMPLATE/api-proposal.md index 90f10fe9e695e..a973d6c6e8b79 100644 --- a/.github/ISSUE_TEMPLATE/api-proposal.md +++ b/.github/ISSUE_TEMPLATE/api-proposal.md @@ -13,7 +13,7 @@ Please provide a thorough explanation of what necessitates the additional API. # Proposed API -Please provide the precise public API signature diff that you are proposing. If modifying existing API signatures this should be expressed using diff blocks, for example +Please provide the precise public API signature diff that you are proposing. If augmenting existing API signatures this should be expressed using diff blocks, for example ```diff namespace System.Collections.Generic { From 15410046e94cb6cdbeb565ecc9ad5ee94773c650 Mon Sep 17 00:00:00 2001 From: Eirik Tsarpalis Date: Wed, 13 May 2020 16:48:40 +0100 Subject: [PATCH 07/12] Update .github/ISSUE_TEMPLATE/api-proposal.md Co-authored-by: Stephen Toub --- .github/ISSUE_TEMPLATE/api-proposal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/api-proposal.md b/.github/ISSUE_TEMPLATE/api-proposal.md index a973d6c6e8b79..045d75670fc32 100644 --- a/.github/ISSUE_TEMPLATE/api-proposal.md +++ b/.github/ISSUE_TEMPLATE/api-proposal.md @@ -24,7 +24,7 @@ namespace System.Collections.Generic # Usage Examples -Please provide code examples that highlight how the proposed API changes are meant to be consumed. +Please provide code examples that highlight how the proposed API additions are meant to be consumed. # Risks From d5da3fc58bd3f8123a1de65b99a9ad31c478197d Mon Sep 17 00:00:00 2001 From: Eirik Tsarpalis Date: Thu, 14 May 2020 18:37:43 +0100 Subject: [PATCH 08/12] comment out template instructions --- .github/ISSUE_TEMPLATE/api-proposal.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/api-proposal.md b/.github/ISSUE_TEMPLATE/api-proposal.md index 045d75670fc32..c613e6f13324d 100644 --- a/.github/ISSUE_TEMPLATE/api-proposal.md +++ b/.github/ISSUE_TEMPLATE/api-proposal.md @@ -9,10 +9,16 @@ assignees: '' # Background and Motivation + + # Proposed API + + # Usage Examples + + # Risks + From 3e98cda5a4c7b9f506d043c4d0b746a08088be02 Mon Sep 17 00:00:00 2001 From: Eirik Tsarpalis Date: Thu, 14 May 2020 18:38:24 +0100 Subject: [PATCH 09/12] apply consistent naming --- .github/ISSUE_TEMPLATE/{api-proposal.md => api_proposal.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{api-proposal.md => api_proposal.md} (100%) diff --git a/.github/ISSUE_TEMPLATE/api-proposal.md b/.github/ISSUE_TEMPLATE/api_proposal.md similarity index 100% rename from .github/ISSUE_TEMPLATE/api-proposal.md rename to .github/ISSUE_TEMPLATE/api_proposal.md From 8564cf9dfc97741f4da705716e6011666ac4babf Mon Sep 17 00:00:00 2001 From: Dan Moseley Date: Thu, 14 May 2020 12:05:00 -0700 Subject: [PATCH 10/12] feedback --- .github/ISSUE_TEMPLATE/api_proposal.md | 31 ++++++++++++--------- .github/ISSUE_TEMPLATE/bug_report.md | 15 ++++++---- .github/ISSUE_TEMPLATE/performance_issue.md | 17 +++++++---- 3 files changed, 39 insertions(+), 24 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/api_proposal.md b/.github/ISSUE_TEMPLATE/api_proposal.md index c613e6f13324d..24d8e0c31d96d 100644 --- a/.github/ISSUE_TEMPLATE/api_proposal.md +++ b/.github/ISSUE_TEMPLATE/api_proposal.md @@ -7,19 +7,17 @@ assignees: '' --- -# Background and Motivation +#### Background and Motivation -# Proposed API +#### Proposed API -# Usage Examples +#### Usage Examples -# Risks +#### Alternative Designs -Please mention any risks that to your knowledge the API proposal might entail, such as breaking changes, performance regressions, etc. +#### Risks + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 56faaf2643fb9..963327e4b0ca8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -9,14 +9,16 @@ assignees: '' -**Description** +#### Description + -**Configuration** +#### Configuration + -**Regression?** +#### Regression? + -**Other information** +#### Other information + diff --git a/.github/ISSUE_TEMPLATE/performance_issue.md b/.github/ISSUE_TEMPLATE/performance_issue.md index 2b325267aaf50..7950513da7a4d 100644 --- a/.github/ISSUE_TEMPLATE/performance_issue.md +++ b/.github/ISSUE_TEMPLATE/performance_issue.md @@ -9,13 +9,15 @@ assignees: '' -**Description** +#### Description + -**Configuration** +#### Configuration + -**Regression?** +#### Regression? + -**Data** +#### Data + -**Analysis** +#### Analysis + From 9a243c00cfe4d023411d251ea60af8bc31d5fae2 Mon Sep 17 00:00:00 2001 From: Dan Moseley Date: Thu, 14 May 2020 12:14:51 -0700 Subject: [PATCH 11/12] add blank --- .github/ISSUE_TEMPLATE/blank.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/blank.md diff --git a/.github/ISSUE_TEMPLATE/blank.md b/.github/ISSUE_TEMPLATE/blank.md new file mode 100644 index 0000000000000..0e3e133dcb9b8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank.md @@ -0,0 +1,8 @@ +--- +name: Blank +about: Something that doesn't fit the other categories +title: '' +labels: '' +assignees: '' + +--- From f12c7ff016664924f89218f9b38d3b1a34290b5d Mon Sep 17 00:00:00 2001 From: Dan Moseley Date: Thu, 14 May 2020 12:38:09 -0700 Subject: [PATCH 12/12] H2 and H3 --- .github/ISSUE_TEMPLATE/api_proposal.md | 12 ++++++------ .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++---- .github/ISSUE_TEMPLATE/performance_issue.md | 10 +++++----- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/api_proposal.md b/.github/ISSUE_TEMPLATE/api_proposal.md index 24d8e0c31d96d..69dd06f60a307 100644 --- a/.github/ISSUE_TEMPLATE/api_proposal.md +++ b/.github/ISSUE_TEMPLATE/api_proposal.md @@ -1,20 +1,20 @@ --- name: API Proposal about: Propose a change to the public API surface. -title: "[API Proposal] Your title goes here" +title: '' labels: api-suggestion assignees: '' --- -#### Background and Motivation +## Background and Motivation -#### Proposed API +## Proposed API -#### Usage Examples +## Usage Examples -#### Alternative Designs +## Alternative Designs -#### Risks +## Risks -#### Description +### Description -#### Configuration +### Configuration -#### Regression? +### Regression? -#### Other information +### Other information -#### Description +### Description -#### Configuration +### Configuration -#### Regression? +### Regression? -#### Data +### Data -#### Analysis +### Analysis