Add 'How to open an issue' to the README (#33947)

pull/33965/head
Luke Latham 2024-10-29 11:48:54 -04:00 committed by GitHub
parent 6f15b09697
commit 8b1d487774
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 44 additions and 0 deletions

View File

@ -0,0 +1,24 @@
---
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/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).
* 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.

View File

@ -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/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).
* 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.