Skip to content

Commit 329537f

Browse files
Use GitHub Issue forms
Update issues to use [GitHub Issue forms](https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms). Contributes to martincostello/repo-migrations#94. Signed-off-by: costellobot[bot] <102247573+costellobot[bot]@users.noreply.github.com>
1 parent d4c80f6 commit 329537f

File tree

4 files changed

+135
-50
lines changed

4 files changed

+135
-50
lines changed
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: 🐛 Bug report
2+
description: Something not behaving as expected?
3+
title: '[Bug]: '
4+
labels: ['bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please check for an existing issue and the [README](https://github.com/martincostello/aspnetcore-openapi/blob/main/README.md) before submitting a bug report.
10+
11+
If you're not using the latest release, please try upgrading to the latest version first to see if the issue resolves itself.
12+
- type: input
13+
attributes:
14+
label: Version
15+
description: Which version of the application are you experiencing the issue with?
16+
placeholder: 1.0.0
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Describe the bug
22+
description: A clear and concise description of what the bug is.
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Expected behaviour
28+
description: A clear and concise description of what you expected to happen.
29+
validations:
30+
required: false
31+
- type: textarea
32+
attributes:
33+
label: Actual behaviour
34+
description: What actually happens.
35+
validations:
36+
required: false
37+
- type: textarea
38+
attributes:
39+
label: Steps to reproduce
40+
description: |
41+
Provide a link to a [minimalistic project which reproduces this issue (repro)](https://stackoverflow.com/help/mcve) hosted in a **public** GitHub repository.
42+
Code snippets, such as a failing unit test or small console app, which demonstrate the issue wrapped in a [fenced code block](https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) are also acceptable.
43+
44+
This issue will be closed if:
45+
- The behaviour you're reporting cannot be easily reproduced.
46+
- The issue is a duplicate of an existing issue.
47+
- The behaviour you're reporting is by design.
48+
validations:
49+
required: false
50+
- type: textarea
51+
attributes:
52+
label: Exception(s) (if any)
53+
description: Include any exception(s) and/or stack trace(s) you get when facing this issue.
54+
render: text
55+
validations:
56+
required: false
57+
- type: input
58+
attributes:
59+
label: .NET Version
60+
description: |
61+
Run `dotnet --version` to get the .NET SDK version you're using.
62+
Alternatively, which target framework(s) (e.g. `net8.0`) does the project you're using the package with target?
63+
placeholder: 9.0.100
64+
validations:
65+
required: false
66+
- type: textarea
67+
attributes:
68+
label: Anything else?
69+
description: |
70+
Links? References? Anything that will give us more context about the issue you are encountering is useful.
71+
72+
💡Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
73+
validations:
74+
required: false
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: 💡 Feature request
2+
description: Suggest a feature request or improvement
3+
title: '[Feature request]: '
4+
labels: ['feature-request']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please check for an existing issue and the [README](https://github.com/martincostello/aspnetcore-openapi/blob/main/README.md) before submitting a feature request.
10+
- type: textarea
11+
attributes:
12+
label: Is your feature request related to a specific problem? Or an existing feature?
13+
description: A clear and concise description of what the problem is. Motivating examples help prioritise things.
14+
placeholder: I am trying to [...] but [...]
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Describe the solution you'd like
20+
description: |
21+
A clear and concise description of what you want to happen. Include any alternative solutions you've considered.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Additional context
27+
description: |
28+
Add any other context or screenshots about the feature request here.
29+
validations:
30+
required: false
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 🤔 Question?
2+
description: You have something specific to achieve and the existing documentation hasn't covered how.
3+
title: '[Question]: '
4+
labels: ['question']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please check for an existing issue and the [README](https://github.com/martincostello/aspnetcore-openapi/blob/main/README.md) before asking a question.
10+
- type: textarea
11+
attributes:
12+
label: What do you want to achieve?
13+
description: A clear and concise description of what you're trying to do.
14+
placeholder: I am trying to [...] but [...]
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: What code or approach do you have so far?
20+
description: |
21+
Provide a [minimalistic project which shows what you have so far](https://stackoverflow.com/help/mcve) hosted in a **public** GitHub repository.
22+
Code snippets wrapped in a [fenced code block](https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) are also acceptable.
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Additional context
28+
description: |
29+
Add any other context or screenshots related to your question here.
30+
validations:
31+
required: false

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

0 commit comments

Comments
 (0)