From ecc5670d9d523acfbf6fd50064292c8d58ed6c04 Mon Sep 17 00:00:00 2001 From: "Andy De George (adegeo)" Date: Tue, 18 Aug 2020 16:17:01 -0700 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/doc-issue.md | 38 ++++---- .../ISSUE_TEMPLATE/dotnet-breaking-change.md | 88 +------------------ 2 files changed, 25 insertions(+), 101 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/doc-issue.md b/.github/ISSUE_TEMPLATE/doc-issue.md index c338d9e80c..e6a7b6b38b 100644 --- a/.github/ISSUE_TEMPLATE/doc-issue.md +++ b/.github/ISSUE_TEMPLATE/doc-issue.md @@ -5,32 +5,40 @@ about: Report a problem in the .NET documentation **Before you open an issue** +(Delete this section before you submit your issue) + If the issue is: -- A simple typo or similar correction, consider submitting a PR to fix it instead of logging an issue. See [the contributor guide](https://docs.microsoft.com/contribute/#quick-edits-to-existing-documents) for instructions. -- A general support question, consider asking on a support forum site. -- A site design concern, create an issue at [MicrosoftDocs/feedback](https://github.com/MicrosoftDocs/feedback/issues/new/choose). +- A simple typo or similar correction, consider submitting a PR to fix it instead of logging an issue. See https://docs.microsoft.com/contribute/#quick-edits-to-existing-documents for instructions + +- A general support question, consider asking on a support forum site such as StackOverflow. + +- A site design concern, create an issue at https://github.com/MicrosoftDocs/feedback/issues/new/choose + - A problem completing a tutorial, compare your code with the completed sample. + - A duplicate of an open or closed issue, leave a comment on that issue. +(Delete the content above before you submit your issue) + **Issue description** -<include description here> +Include description here -**Target framework** +**.NET or .NET Framework** -Check the .NET target framework(s) being used, and include the version number(s). +Check the .NET target framework(s) being used, and include the version number(s). Put an `x` between the `[ ]` to check it. -- [ ] .NET Core +- [ ] .NET (5 or Core) - [ ] .NET Framework -- [ ] .NET Standard -If using the .NET Core SDK, include `dotnet --info` output. If using .NET Framework without the .NET Core SDK, include info from Visual Studio's **Help** > **About Microsoft Visual Studio** dialog. +**Technology** + +Check the .NET target framework(s) being used, and include the version number(s). Put an `x` between the `[ ]` to check it. + +- [ ] WPF +- [ ] Windows Forms -
-dotnet --info output or About VS info +**.NET information** -```console - -``` -
+If using the .NET SDK or .NET Core SDK, include `dotnet --info` output. If using .NET Framework without the .NET Core SDK, include info from Visual Studio's **Help** > **About Microsoft Visual Studio** dialog. diff --git a/.github/ISSUE_TEMPLATE/dotnet-breaking-change.md b/.github/ISSUE_TEMPLATE/dotnet-breaking-change.md index 0fbe711d67..951ef37b03 100644 --- a/.github/ISSUE_TEMPLATE/dotnet-breaking-change.md +++ b/.github/ISSUE_TEMPLATE/dotnet-breaking-change.md @@ -3,90 +3,6 @@ name: .NET Core breaking change about: Report a change in .NET Core that breaks something that worked in a previous version (intended mostly for product-team use) --- - - -## [Change title] - -[Brief description of the change] - -### Version introduced - -[Version in which the breaking change first occurred (for example, 3.0 for .NET Core 3.0)] - -### Old behavior - -### New behavior - -### Reason for change - -### Recommended action - -[ Suggested steps if user is affected go here: -- Possible workarounds -- Example of code changes to handle change -] - -### Category - -[Choose a category from one of the following: - -- ASP.NET Core -- C# -- Core .NET libraries -- Cryptography -- Data -- Debugger -- Deployment -- Globalization -- Interop -- JIT -- LINQ -- Managed Extensibility Framework (MEF) -- MSBuild -- Networking -- Printing -- Security -- Serialization -- Visual Basic -- Windows Forms -- Windows Presentation Foundation (WPF) -- XML, XSLT -] - -### Affected APIs - -[ If no APIs are affected, this should read: - "Not detectable via API analysis" - - If affected APIs are identifiable, include a link for each. The link takes the form: - - `[friendly description of API](link to API on docs.microsoft.com)` - - For example, `[String.IndexOf(String)](https://docs.microsoft.com/dotnet/api/system.string.indexof#System_String_IndexOf_System_String_) - - For methods, if all overloads are affected, link to the general overloaded method page. For example: - - - - Otherwise, link to the individual method overload. For example: - - - -] - - - ---- -#### Issue metadata - -* Issue type: breaking-change +File a breaking change bug at https://github.com/dotnet/docs/issues/new?template=dotnet-breaking-change.md