Skip to content

Commit 3db5f01

Browse files
chore: create bug report form (#428)
* chore: create bug report form * clarify description * add textarea for bug description * indent properly * further work * further work * Add tip about checking eslintrc file for rules * Add tip about checking eslintrc file for ESLint config * put placeholder sentence between single quotes * Put placeholder sentence between single quotes * Fix typo in label name Co-authored-by: Michaël De Boey <[email protected]> * Make anything else field optional Co-authored-by: Michaël De Boey <[email protected]> Co-authored-by: Michaël De Boey <[email protected]>
1 parent c9b476c commit 3db5f01

File tree

1 file changed

+116
-0
lines changed

1 file changed

+116
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
name: Bug Report
2+
description: File a bug report
3+
labels: [bug]
4+
body:
5+
- type: input
6+
id: plugin_version
7+
attributes:
8+
label: Plugin version
9+
description: What version of `eslint-plugin-testing-library` are you using?
10+
placeholder: v4.10.1
11+
validations:
12+
required: true
13+
14+
- type: input
15+
id: eslint_version
16+
attributes:
17+
label: ESLint version
18+
description: What version of ESLint are you using?
19+
placeholder: v7.31.0
20+
validations:
21+
required: true
22+
23+
- type: input
24+
id: node_js_version
25+
attributes:
26+
label: Node.js version
27+
description: What version of Node.js are you using?
28+
placeholder: 14.17.3
29+
validations:
30+
required: true
31+
32+
- type: input
33+
id: npm_yarn_version
34+
attributes:
35+
label: npm/yarn version
36+
description: Tell us whether you use npm or yarn as your package manager, and what version.
37+
placeholder: npm 6.14.13
38+
validations:
39+
required: true
40+
41+
- type: input
42+
id: operating_system
43+
attributes:
44+
label: Operating system
45+
description: Tell us what operating system you use, and what version.
46+
placeholder: macOS Big Sur, version 11.4
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: bug_description
52+
attributes:
53+
label: Bug description
54+
description: Describe the bug at a high level.
55+
placeholder: I was doing ..., but I expected ...
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: steps_to_reproduce
61+
attributes:
62+
label: Steps to reproduce
63+
description: Give us a ordered list of the steps to reproduce the problem.
64+
placeholder: |
65+
1. Go to ...
66+
2. Do ....
67+
3. See bug
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: error_output_screenshots
73+
attributes:
74+
label: Error output/screenshots
75+
description: Copy/paste any error messages or helpful screenshots into this field.
76+
placeholder: 'Tip: you can copy/paste error messages in here. You can click and drag screenshots into this field.'
77+
validations:
78+
required: false
79+
80+
- type: textarea
81+
id: eslint_config
82+
attributes:
83+
label: ESLint configuration
84+
description: Copy/paste your ESLint configuration into this field.
85+
placeholder: 'Tip: you can find your ESLint configuration in the `.eslintrc` file.'
86+
validations:
87+
required: true
88+
89+
- type: textarea
90+
id: rule_affected
91+
attributes:
92+
label: Rule(s) affected
93+
description: Tell us what `eslint-pluging-testing-library` rule(s) are affected by this bug.
94+
placeholder: 'Tip: check your `.eslintrc` for rules.'
95+
validations:
96+
required: true
97+
98+
- type: textarea
99+
id: anything_else
100+
attributes:
101+
label: Anything else?
102+
description: If there's anything else we need to know, tell us about it here.
103+
placeholder: By the way, you also need to know about...
104+
validations:
105+
required: false
106+
107+
- type: dropdown
108+
id: want_to_submit_pr_to_fix_bug
109+
attributes:
110+
label: Do you want to submit a pull request to fix this bug?
111+
options:
112+
- 'Yes'
113+
- 'Yes, but need help'
114+
- 'No'
115+
validations:
116+
required: true

0 commit comments

Comments
 (0)