Skip to content

Commit 7246d13

Browse files
committed
Updated issue templates
1 parent 9e0fed8 commit 7246d13

File tree

4 files changed

+52
-15
lines changed

4 files changed

+52
-15
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# I don't want to read this whole thing I just have a question!!!
22

3-
> Note: Please don't file an issue to ask a question.
4-
5-
You'll get faster results by using our official [Gitter channel](https://gitter.im/json-api-dotnet-core/Lobby) or [StackOverflow](https://stackoverflow.com/search?q=jsonapidotnetcore) where the community chimes in with helpful advice if you have questions.
3+
> You can file an issue to ask a question, but you'll get faster results by using our official [Gitter channel](https://gitter.im/json-api-dotnet-core/Lobby) or [StackOverflow](https://stackoverflow.com/search?q=jsonapidotnetcore) where the community chimes in with helpful advice if you have questions.
64
75
# How can I contribute?
86

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
name: Bug report
33
about: Create a report to help us improve
44
title: ''
5-
labels: ''
5+
labels: 'bug'
66
assignees: ''
77

88
---
99

10-
_Please read our [Contributing Guides](https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/.github/CONTRIBUTING.md) before submitting a bug._
10+
<!-- Please read our [Contributing Guides](https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/.github/CONTRIBUTING.md) before submitting a bug. -->
1111

1212
#### DESCRIPTION
13-
_A clear and concise description of what the bug is._
13+
<!-- A clear and concise description of what the bug is. -->
1414

1515
#### STEPS TO REPRODUCE
16-
_Consider to include your code here, such as models, DbContext, controllers, resource services, repositories, resource definitions etc. Please also include the request URL with body (if applicable) and the full exception stack trace (set `options.IncludeExceptionStackTraceInErrors` to `true`) in case of errors._ It may also be helpful to include the produced SQL, which can be made visible in logs by adding this to appsettings.json:
16+
<!-- Consider to include your code here, such as models, DbContext, controllers, resource services, repositories, resource definitions etc. Please also include the request URL with body (if applicable) and the full exception stack trace (set `options.IncludeExceptionStackTraceInErrors` to `true`) in case of errors._ It may also be helpful to include the produced SQL, which can be made visible in logs by adding this to appsettings.json:
1717
1818
```json
1919
{
@@ -24,16 +24,17 @@ _Consider to include your code here, such as models, DbContext, controllers, res
2424
}
2525
}
2626
```
27+
-->
2728

2829
1.
2930
2.
3031
3.
3132

3233
#### EXPECTED BEHAVIOR
33-
_A clear and concise description of what you expected to happen._
34+
<!-- A clear and concise description of what you expected to happen. -->
3435

3536
#### ACTUAL BEHAVIOR
36-
_A clear and concise description of what happens instead._
37+
<!-- A clear and concise description of what happens instead. -->
3738

3839
#### VERSIONS USED
3940
- JsonApiDotNetCore version:

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22
name: Feature request
33
about: Suggest an idea for this project
44
title: ''
5-
labels: ''
5+
labels: 'enhancement'
66
assignees: ''
77

88
---
99

10-
_Please read our [Contributing Guides](https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/.github/CONTRIBUTING.md) before suggesting an idea._
10+
<!-- Please read our [Contributing Guides](https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/.github/CONTRIBUTING.md) before suggesting an idea. -->
1111

1212
**Is your feature request related to a problem? Please describe.**
13-
_A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_
13+
<!-- A clear and concise description of what the problem is. For example: I'm always frustrated when... -->
1414

1515
**Describe the solution you'd like**
16-
_A clear and concise description of what you want to happen._
16+
<!-- A clear and concise description of what you want to happen. -->
1717

1818
**Describe alternatives you've considered**
19-
_A clear and concise description of any alternative solutions or features you've considered._
19+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
2020

2121
**Additional context**
22-
_Add any other context or screenshots about the feature request here._
22+
<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Question
3+
about: Ask a question
4+
title: ''
5+
labels: 'question'
6+
assignees: ''
7+
8+
---
9+
10+
#### SUMMARY
11+
<!-- Explain what you're trying to accomplish, how you encountered the problem you're trying to solve, and any difficulties that have prevented you from solving it yourself. -->
12+
13+
#### DETAILS
14+
<!-- What details can you include that will help us identify and solve your problem? -->
15+
16+
#### STEPS TO REPRODUCE
17+
<!-- Not all questions benefit from including code, but if your problem is with the code you've written, you should consider including your models, DbContext, controllers, resource services, repositories, resource definitions, etc. Include the request URL with body (if applicable) and the full exception stack trace (set `options.IncludeExceptionStackTraceInErrors` to `true`) in case of errors. It may also be helpful to include the produced SQL, which can be made visible in logs by adding this to appsettings.json:
18+
19+
```json
20+
{
21+
"Logging": {
22+
"LogLevel": {
23+
"Microsoft.EntityFrameworkCore.Database.Command": "Information"
24+
}
25+
}
26+
}
27+
```
28+
-->
29+
30+
1.
31+
2.
32+
3.
33+
34+
#### VERSIONS USED
35+
- JsonApiDotNetCore version:
36+
- ASP.NET Core version:
37+
- Entity Framework Core version:
38+
- Database provider:

0 commit comments

Comments
 (0)