Skip to content

Commit 4d90721

Browse files
micaleviskmicalevisk
committed
chore(): migrate to github issue forms
1 parent a403003 commit 4d90721

File tree

5 files changed

+243
-46
lines changed

5 files changed

+243
-46
lines changed

‎.github/ISSUE_TEMPLATE.md

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

‎.github/ISSUE_TEMPLATE/Bug_report.yml

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
name: "\U0001F41B Bug Report"
2+
description: "If something isn't working as expected \U0001F914"
3+
labels: ["needs triage", "bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## :warning: We use GitHub Issues to track bug reports, feature requests and regressions
9+
10+
If you are not sure that your issue is a bug, you could:
11+
12+
- use our [Discord community](https://discord.gg/NestJS)
13+
- use [StackOverflow using the tag `nestjs`](https://stackoverflow.com/questions/tagged/nestjs)
14+
- If it's just a quick question you can ping [our Twitter](https://twitter.com/nestframework)
15+
16+
**NOTE:** You don't need to answer questions that you know that aren't relevant.
17+
18+
---
19+
20+
- type: checkboxes
21+
attributes:
22+
label: "Is there an existing issue for this?"
23+
description: "Please search [here](./?q=is%3Aissue) to see if an issue already exists for the bug you encountered"
24+
options:
25+
- label: "I have searched the existing issues"
26+
required: true
27+
28+
- type: textarea
29+
validations:
30+
required: true
31+
attributes:
32+
label: "Current behavior"
33+
description: "How the issue manifests?"
34+
35+
- type: input
36+
validations:
37+
required: true
38+
attributes:
39+
label: "Minimum reproduction code"
40+
description: "An URL to some git repository or gist that reproduces this issue. [Wtf is a minimum reproduction?](https://jmcdo29.github.io/wtf-is-a-minimum-reproduction)"
41+
placeholder: "https://github.com/..."
42+
43+
- type: textarea
44+
attributes:
45+
label: "Steps to reproduce"
46+
description: |
47+
How the issue manifests?
48+
You could leave this blank if you alread write this in your reproduction code/repo
49+
placeholder: |
50+
1. `npm i`
51+
2. `npm start:dev`
52+
3. See error...
53+
54+
- type: textarea
55+
validations:
56+
required: true
57+
attributes:
58+
label: "Expected behavior"
59+
description: "A clear and concise description of what you expected to happend (or code)"
60+
61+
- type: markdown
62+
attributes:
63+
value: |
64+
---
65+
66+
- type: input
67+
validations:
68+
required: true
69+
attributes:
70+
label: "Package version"
71+
description: |
72+
Which version of `@nestjs/config` are you using?
73+
**Tip**: Make sure that all of yours `@nestjs/*` dependencies are in sync!
74+
placeholder: "8.1.3"
75+
76+
- type: input
77+
attributes:
78+
label: "NestJS version"
79+
description: "Which version of `@nestjs/core` are you using?"
80+
placeholder: "8.1.3"
81+
82+
- type: input
83+
attributes:
84+
label: "Node.js version"
85+
description: "Which version of Node.js are you using?"
86+
placeholder: "14.17.6"
87+
88+
- type: checkboxes
89+
attributes:
90+
label: "In which operating systems have you tested?"
91+
options:
92+
- label: macOS
93+
- label: Windows
94+
- label: Linux
95+
96+
- type: markdown
97+
attributes:
98+
value: |
99+
---
100+
101+
- type: textarea
102+
attributes:
103+
label: "Other"
104+
description: |
105+
Anything else relevant? eg: Logs, OS version, IDE, package manager, etc.
106+
**Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in

‎.github/ISSUE_TEMPLATE/Feature_request.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: "\U0001F680 Feature Request"
2+
description: "I have a suggestion \U0001F63B!"
3+
labels: ["feature"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## :warning: We use GitHub Issues to track bug reports, feature requests and regressions
9+
10+
If you are not sure that your issue is a bug, you could:
11+
12+
- use our [Discord community](https://discord.gg/NestJS)
13+
- use [StackOverflow using the tag `nestjs`](https://stackoverflow.com/questions/tagged/nestjs)
14+
- If it's just a quick question you can ping [our Twitter](https://twitter.com/nestframework)
15+
16+
---
17+
18+
- type: checkboxes
19+
attributes:
20+
label: "Is there an existing issue that is already proposing this?"
21+
description: "Please search [here](./?q=is%3Aissue) to see if an issue already exists for the feature you are requesting"
22+
options:
23+
- label: "I have searched the existing issues"
24+
required: true
25+
26+
- type: textarea
27+
validations:
28+
required: true
29+
attributes:
30+
label: "Is your feature request related to a problem? Please describe it"
31+
description: "A clear and concise description of what the problem is"
32+
placeholder: |
33+
I have an issue when ...
34+
35+
- type: textarea
36+
validations:
37+
required: true
38+
attributes:
39+
label: "Describe the solution you'd like"
40+
description: "A clear and concise description of what you want to happen. Add any considered drawbacks"
41+
42+
- type: textarea
43+
attributes:
44+
label: "Teachability, documentation, adoption, migration strategy"
45+
description: "If you can, explain how users will be able to use this and possibly write out a version the docs. Maybe a screenshot or design?"
46+
47+
- type: textarea
48+
validations:
49+
required: true
50+
attributes:
51+
label: "What is the motivation / use case for changing the behavior?"
52+
description: "Describe the motivation or the concrete use case"

‎.github/ISSUE_TEMPLATE/Regression.yml

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: "\U0001F4A5 Regression"
2+
description: "Report an unexpected behavior while upgrading your Nest application!"
3+
labels: ["needs triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## :warning: We use GitHub Issues to track bug reports, feature requests and regressions
9+
10+
If you are not sure that your issue is a bug, you could:
11+
12+
- use our [Discord community](https://discord.gg/NestJS)
13+
- use [StackOverflow using the tag `nestjs`](https://stackoverflow.com/questions/tagged/nestjs)
14+
- If it's just a quick question you can ping [our Twitter](https://twitter.com/nestframework)
15+
16+
**NOTE:** You don't need to answer questions that you know that aren't relevant.
17+
18+
---
19+
20+
- type: checkboxes
21+
attributes:
22+
label: "Did you read the migration guide?"
23+
description: "Check out the [migration guide here](https://docs.nestjs.com/migration-guide)!"
24+
options:
25+
- label: "I have read the whole migration guide"
26+
required: false
27+
28+
- type: checkboxes
29+
attributes:
30+
label: "Is there an existing issue that is already proposing this?"
31+
description: "Please search [here](./?q=is%3Aissue) to see if an issue already exists for the feature you are requesting"
32+
options:
33+
- label: "I have searched the existing issues"
34+
required: true
35+
36+
- type: input
37+
attributes:
38+
label: "Potential Commit/PR that introduced the regression"
39+
description: "If you have time to investigate, what PR/date/version introduced this issue"
40+
placeholder: "PR #123 or commit 5b3c4a4"
41+
42+
- type: input
43+
attributes:
44+
label: "Versions"
45+
description: "From which version of `@nestjs/config` to which version you are upgrading"
46+
placeholder: "8.1.0 -> 8.1.3"
47+
48+
- type: textarea
49+
validations:
50+
required: true
51+
attributes:
52+
label: "Describe the regression"
53+
description: "A clear and concise description of what the regression is"
54+
55+
- type: textarea
56+
attributes:
57+
label: "Minimum reproduction code"
58+
description: |
59+
Please share a git repo, a gist, or step-by-step instructions. [Wtf is a minimum reproduction?](https://jmcdo29.github.io/wtf-is-a-minimum-reproduction)
60+
**Tip:** If you leave a minimum repository, we will understand your issue faster!
61+
value: |
62+
```ts
63+
64+
```
65+
66+
- type: textarea
67+
validations:
68+
required: true
69+
attributes:
70+
label: "Expected behavior"
71+
description: "A clear and concise description of what you expected to happend (or code)"
72+
73+
- type: textarea
74+
attributes:
75+
label: "Other"
76+
description: |
77+
Anything else relevant? eg: Logs, OS version, IDE, package manager, etc.
78+
**Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## To encourage contributors to use issue templates, we don't allow blank issues
2+
blank_issues_enabled: false
3+
4+
contact_links:
5+
- name: "\u2753 Discord Community of NestJS"
6+
url: "https://discord.gg/NestJS"
7+
about: "Please ask support questions or discuss suggestions/enhancements here."

0 commit comments

Comments
 (0)