Skip to content

Commit 127c590

Browse files
Tidy up issue templates
Use markdown headings and use comments for hints.
1 parent 267f748 commit 127c590

File tree

3 files changed

+66
-25
lines changed

3 files changed

+66
-25
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,29 @@
11
### Provider name
22

3-
_State which provider(s) you are experiencing an issue with._
3+
<!--
4+
State which provider(s) you are experiencing an issue with.
5+
-->
46

57
### Expected behavior
68

7-
_Explain what you expected to happen._
9+
<!--
10+
Explain what you expected to happen.
11+
-->
812

913
### Actual behavior
1014

11-
_Explain what actually happened. If an exception occurred, please include a stack trace if available._
15+
<!--
16+
Explain what actually happened. If an exception occurred, please include a stack trace if available.
17+
-->
1218

1319
### Steps to reproduce
1420

15-
_A concise and repeatable example of how to illustrate the issue._
21+
<!--
22+
A concise and repeatable example of how to illustrate the issue.
23+
-->
1624

1725
### Additional information
1826

19-
_Any additional information that may be useful, such as the version of the package you are using or the version of .NET Core._
27+
<!--
28+
Any additional information that may be useful, such as the version of the package you are using or the version of .NET.
29+
-->

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,44 @@
11
---
22
name: Bug report
33
about: Create a bug report to help us improve AspNet.Security.OAuth.Providers
4+
labels: bug
45

56
---
67

7-
**Describe the bug**
8-
_A clear and concise description of what the bug is. State which provider(s) the bug relates to._
8+
### Describe the bug
99

10-
**Steps To reproduce**
11-
_A concise and repeatable example of how to illustrate the issue._
10+
<!--
11+
A clear and concise description of what the bug is. State which provider(s) the bug relates to.
12+
-->
1213

13-
**Expected behaviour**
14-
_A clear and concise description of what you expected to happen._
14+
### Steps To reproduce
1515

16-
**Actual behaviour**
17-
_A clear and concise description of what actually happened. If an exception occurred, please include a stack trace if available._
16+
<!--
17+
A concise and repeatable example of how to illustrate the issue.
18+
-->
1819

19-
**System information:**
20-
- OS: [e.g. Windows 10]
21-
- Library Version [e.g. 2.0.1]
22-
- .NET version (e.g. output from `dotnet --info`)
20+
### Expected behaviour
2321

24-
**Additional context**
25-
_Add any other context about the problem here._
22+
<!--
23+
A clear and concise description of what you expected to happen.
24+
-->
25+
26+
### Actual behaviour
27+
28+
<!--
29+
A clear and concise description of what actually happened. If an exception occurred, please include a stack trace if available.
30+
-->
31+
32+
### System information
33+
34+
<!--
35+
- OS: [e.g. Windows 11]
36+
- Library Version [e.g. 6.0.0]
37+
- .NET version (e.g. output from `dotnet --info`)
38+
-->
39+
40+
### Additional context
41+
42+
<!--
43+
Add any other context about the problem here.
44+
-->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,26 @@ about: Suggest an idea for a new feature for AspNet.Security.OAuth.Providers
44

55
---
66

7-
**Is your feature request related to a problem? Please describe.**
8-
A clear and concise description of what the problem is. For example: _I'm always frustrated when [...]_
7+
### Is your feature request related to a problem? Please describe.
98

10-
**Describe the solution you'd like**
11-
A clear and concise description of what you want to happen.
9+
<!--
10+
A clear and concise description of what the problem is. For example: _It would be useful if [...]_
11+
-->
1212

13-
**Describe alternatives you've considered**
13+
### Describe the solution you'd like
14+
15+
<!--
16+
A clear and concise description of what you would like to happen.
17+
-->
18+
19+
### Describe alternatives you've considered
20+
21+
<!--
1422
A clear and concise description of any alternative solutions or features you've considered.
23+
-->
24+
25+
### Additional context
1526

16-
**Additional context**
27+
<!--
1728
Add any other context or screenshots about the feature request here.
29+
-->

0 commit comments

Comments
 (0)