From 3c89c7866f3c17415e543a445a6563ad2b328cfc Mon Sep 17 00:00:00 2001 From: Luke Latham <1622880+guardrex@users.noreply.github.com> Date: Mon, 28 Oct 2024 09:54:23 -0400 Subject: [PATCH 1/5] Add 'How to open an issue' to the README --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index cd8f205ca087..8fb0a524ebea 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,23 @@ This repository contains the [ASP.NET Core documentation](https://learn.microsof To provide comments and suggestions on [learn.microsoft.com](https://learn.microsoft.com) site functionality, open an issue in the [`MicrosoftDocs/feedback` GitHub repository](https://github.com/MicrosoftDocs/feedback). ASP.NET 4.x documentation changes are made in the [`dotnet/AspNetDocs` GitHub repository](https://github.com/dotnet/AspNetDocs). + +## How to open an issue + +If the issue is with an ASP.NET Core document: + +* Do **not** open a blank issue. +* Open the issue using the **Open a documentation issue** link and feedback form at the bottom of the article. + +Using the **Open a documentation issue** link and form to open an issue adds article metadata for tracking, which indicates the article that you're commenting on and automatically pings the author for a faster response. + +If the issue is: + +* A simple typo or similar correction, you can submit a PR. 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: + * [Stack Overflow](https://stackoverflow.com/questions) + * [ASP.NET Core Slack](https://aspnetcore.slack.com/join/shared_invite/zt-1mv5487zb-EOZxJ1iqb0A0ajowEbxByQ#/shared-invite/email) + * [ASP.NET Gitter](https://gitter.im/aspnet/Home) +* A site design concern, create an issue at [MicrosoftDocs/Feedback](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. From 68f8c5dee4eeb5b7d9e7f9f9188ea4a40900601d Mon Sep 17 00:00:00 2001 From: Luke Latham <1622880+guardrex@users.noreply.github.com> Date: Mon, 28 Oct 2024 10:08:35 -0400 Subject: [PATCH 2/5] Create blank-issue.md --- .github/ISSUE_TEMPLATE/blank-issue.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/blank-issue.md diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md new file mode 100644 index 000000000000..541736dcfbdf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank-issue.md @@ -0,0 +1,23 @@ +--- +name: Doc issue +about: Create an issue to help us improve +--- +# Before you open an issue + +If the issue is with an ASP.NET Core document: + +* Do **not** open a new issue using this form. +* Open the issue using the **Open a documentation issue** link and feedback form at the bottom of the article. + +Using the **Open a documentation issue** link and form to open an issue adds article metadata for tracking, which indicates the article that you're commenting on and pings the author for a faster response. + +If the issue is: + +* A simple typo or similar correction, you can submit a PR. 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: + * [Stack Overflow](https://stackoverflow.com/questions) + * [ASP.NET Core Slack](https://aspnetcore.slack.com/join/shared_invite/zt-1mv5487zb-EOZxJ1iqb0A0ajowEbxByQ#/shared-invite/email) + * [ASP.NET Gitter](https://gitter.im/aspnet/Home) +* A site design concern, create an issue at [MicrosoftDocs/Feedback](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. From 75d2b5617c8c505b5fbd20cf3712596a7e56c1bd Mon Sep 17 00:00:00 2001 From: Luke Latham <1622880+guardrex@users.noreply.github.com> Date: Mon, 28 Oct 2024 10:13:53 -0400 Subject: [PATCH 3/5] NIT to the template to match the others --- .github/ISSUE_TEMPLATE/blank-issue.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md index 541736dcfbdf..54db57ef73db 100644 --- a/.github/ISSUE_TEMPLATE/blank-issue.md +++ b/.github/ISSUE_TEMPLATE/blank-issue.md @@ -2,6 +2,7 @@ name: Doc issue about: Create an issue to help us improve --- + # Before you open an issue If the issue is with an ASP.NET Core document: From 90d8c2d58a74f02fc1c28d9ced8cdc1c3be2ad40 Mon Sep 17 00:00:00 2001 From: Luke Latham <1622880+guardrex@users.noreply.github.com> Date: Tue, 29 Oct 2024 05:38:54 -0400 Subject: [PATCH 4/5] Add tag to SO link --- .github/ISSUE_TEMPLATE/blank-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md index 54db57ef73db..1ff6f0363f00 100644 --- a/.github/ISSUE_TEMPLATE/blank-issue.md +++ b/.github/ISSUE_TEMPLATE/blank-issue.md @@ -16,7 +16,7 @@ If the issue is: * A simple typo or similar correction, you can submit a PR. 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: - * [Stack Overflow](https://stackoverflow.com/questions) + * [Stack Overflow](https://stackoverflow.com/questions/tagged/asp.net-core) * [ASP.NET Core Slack](https://aspnetcore.slack.com/join/shared_invite/zt-1mv5487zb-EOZxJ1iqb0A0ajowEbxByQ#/shared-invite/email) * [ASP.NET Gitter](https://gitter.im/aspnet/Home) * A site design concern, create an issue at [MicrosoftDocs/Feedback](https://github.com/MicrosoftDocs/Feedback/issues/new/choose). From b5a975f9d83c3b5adc822dde562e1b4b80ef27b4 Mon Sep 17 00:00:00 2001 From: Luke Latham <1622880+guardrex@users.noreply.github.com> Date: Tue, 29 Oct 2024 05:39:19 -0400 Subject: [PATCH 5/5] Add tag to SO link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8fb0a524ebea..a7f624ec7d3c 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ If the issue is: * A simple typo or similar correction, you can submit a PR. 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: - * [Stack Overflow](https://stackoverflow.com/questions) + * [Stack Overflow](https://stackoverflow.com/questions/tagged/asp.net-core) * [ASP.NET Core Slack](https://aspnetcore.slack.com/join/shared_invite/zt-1mv5487zb-EOZxJ1iqb0A0ajowEbxByQ#/shared-invite/email) * [ASP.NET Gitter](https://gitter.im/aspnet/Home) * A site design concern, create an issue at [MicrosoftDocs/Feedback](https://github.com/MicrosoftDocs/Feedback/issues/new/choose).