Skip to content

Commit 8b1d487

Browse files
authored
Add 'How to open an issue' to the README (#33947)
1 parent 6f15b09 commit 8b1d487

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Doc issue
3+
about: Create an issue to help us improve
4+
---
5+
6+
# Before you open an issue
7+
8+
If the issue is with an ASP.NET Core document:
9+
10+
* Do **not** open a new issue using this form.
11+
* Open the issue using the **Open a documentation issue** link and feedback form at the bottom of the article.
12+
13+
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.
14+
15+
If the issue is:
16+
17+
* 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.
18+
* A general support question, consider asking on a support forum site:
19+
* [Stack Overflow](https://stackoverflow.com/questions/tagged/asp.net-core)
20+
* [ASP.NET Core Slack](https://aspnetcore.slack.com/join/shared_invite/zt-1mv5487zb-EOZxJ1iqb0A0ajowEbxByQ#/shared-invite/email)
21+
* [ASP.NET Gitter](https://gitter.im/aspnet/Home)
22+
* A site design concern, create an issue at [MicrosoftDocs/Feedback](https://github.com/MicrosoftDocs/Feedback/issues/new/choose).
23+
* A problem completing a tutorial, compare your code with the completed sample.
24+
* A duplicate of an open or closed issue, leave a comment on that issue.

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,23 @@ This repository contains the [ASP.NET Core documentation](https://learn.microsof
55
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).
66

77
ASP.NET 4.x documentation changes are made in the [`dotnet/AspNetDocs` GitHub repository](https://github.com/dotnet/AspNetDocs).
8+
9+
## How to open an issue
10+
11+
If the issue is with an ASP.NET Core document:
12+
13+
* Do **not** open a blank issue.
14+
* Open the issue using the **Open a documentation issue** link and feedback form at the bottom of the article.
15+
16+
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.
17+
18+
If the issue is:
19+
20+
* 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.
21+
* A general support question, consider asking on a support forum site:
22+
* [Stack Overflow](https://stackoverflow.com/questions/tagged/asp.net-core)
23+
* [ASP.NET Core Slack](https://aspnetcore.slack.com/join/shared_invite/zt-1mv5487zb-EOZxJ1iqb0A0ajowEbxByQ#/shared-invite/email)
24+
* [ASP.NET Gitter](https://gitter.im/aspnet/Home)
25+
* A site design concern, create an issue at [MicrosoftDocs/Feedback](https://github.com/MicrosoftDocs/Feedback/issues/new/choose).
26+
* A problem completing a tutorial, compare your code with the completed sample.
27+
* A duplicate of an open or closed issue, leave a comment on that issue.

0 commit comments

Comments
 (0)