Skip to content

Commit 05ffd04

Browse files
wooormwooorm
committed
Refactor bug template
1 parent 70c551d commit 05ffd04

1 file changed

Lines changed: 37 additions & 62 deletions

File tree

‎.github/ISSUE_TEMPLATE/1-bug.yml‎

Lines changed: 37 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
name: 🐛 Bug report
2-
description: Describe a problem
3-
2+
description: Describe a bug with a project
43
body:
54
- type: markdown
65
attributes:
76
value: |
87
Some general tips:
98
10-
- Is this really a problem?
11-
- Is this a problem here?
12-
- Can this be solved in a different way?
13-
9+
* Is this really a problem?
10+
* Is this a problem here?
11+
* Can this be solved in a different way?
1412
- type: checkboxes
1513
id: initial-checklist
1614
attributes:
@@ -24,122 +22,99 @@ body:
2422
required: true
2523
- label: I searched [issues](https://github.com/search?q=user%3Aunifiedjs&type=Issues) and couldn’t find anything (or linked relevant results below)
2624
required: true
27-
2825
- type: input
2926
id: affected-versions
3027
attributes:
3128
label: Affected packages and versions
3229
description: Please test using the latest version of the relevant packages to make sure your issue has not already been fixed.
3330
validations:
3431
required: true
35-
3632
- type: input
3733
id: runnable-example
3834
attributes:
3935
label: Link to runnable example
4036
description: |
4137
Link to repository or sandbox with runnable example of the issue.
38+
Alternatively, use the next section *Steps to reproduce*.
4239
43-
Some CodeSandbox starters:
44-
- [remark only](https://codesandbox.io/s/remark-debug-ikwvx) (for markdown to markdown)
45-
- [remark and rehype](https://codesandbox.io/s/remark-rehype-debug-4cz8v) (for markdown to html)
46-
- [react-markdown](https://codesandbox.io/s/react-markdown-debug-9n4eg)
40+
Some starters:
4741
48-
Alternatively, use the next section *Steps to reproduce*.
42+
| description | codesandbox | stackblitz |
43+
| - | - | - |
44+
| remark only (for markdown to markdown) | [codesandbox](https://codesandbox.io/s/github/remarkjs/.github/tree/main/sandbox-templates/remark-with-parcel) | [stackblitz](https://stackblitz.com/github/remarkjs/.github/tree/main/sandbox-templates/remark-with-parcel) |
45+
| remark and rehype (for markdown to html) | [codesandbox](https://codesandbox.io/s/github/remarkjs/.github/tree/main/sandbox-templates/remark-rehype-with-parcel) | [stackblitz](https://stackblitz.com/github/remarkjs/.github/tree/main/sandbox-templates/remark-rehype-with-parcel) |
46+
| react-markdown | [codesandbox](https://codesandbox.io/s/github/remarkjs/.github/tree/main/sandbox-templates/react-markdown-with-create-react-app) | [stackblitz](https://stackblitz.com/github/remarkjs/.github/tree/main/sandbox-templates/react-markdown-with-create-react-app) |
4947
validations:
5048
required: false
51-
5249
- type: textarea
5350
id: steps-to-reproduce
5451
attributes:
5552
label: Steps to reproduce
5653
description: How did this happen? Please provide a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
5754
validations:
5855
required: true
59-
6056
- type: textarea
6157
id: expected-behavior
6258
attributes:
6359
label: Expected behavior
6460
description: What should happen?
6561
validations:
6662
required: true
67-
6863
- type: textarea
6964
id: actual-behavior
7065
attributes:
7166
label: Actual behavior
7267
description: What happens instead?
7368
validations:
7469
required: true
75-
76-
- type: dropdown
77-
id: javascript-runtime
70+
- type: input
71+
id: runtime
7872
attributes:
79-
label: Runtime
73+
label: Affected runtime and version
8074
description: |
81-
What JavaScript runtime are you using to build or run the code?
82-
**Note**: for ECMASCript modules (ESM) in Node, at minimum Node.js 12.20, 14.14, or 16.0 is required.
83-
multiple: true
84-
options:
85-
- Node v16
86-
- Node v14
87-
- Node v12
88-
- Deno v1
89-
- Electron v13
90-
- Electron v12
91-
- Electron v11
92-
- Other (please specify in steps to reproduce)
75+
What runtime are you using (e.g., `node@18.2`, `deno@1.12.2`)?
76+
Please test using the latest version.
9377
validations:
94-
required: false
95-
96-
- type: dropdown
78+
required: true
79+
- type: input
9780
id: package-manager
9881
attributes:
99-
label: Package manager
100-
description: What package manager are you using?
101-
multiple: true
102-
options:
103-
- npm v6
104-
- npm v7
105-
- yarn v1
106-
- yarn v2
107-
- pnpm
108-
- Other (please specify in steps to reproduce)
82+
label: Affected package manager and version
83+
description: |
84+
What package manager are you using (e.g., `npm@8.9.0`)?
85+
Please test using the latest version.
10986
validations:
11087
required: false
111-
112-
- type: dropdown
88+
- type: input
11389
id: operating-system
11490
attributes:
115-
label: OS
116-
description: What operating system are you using?
117-
multiple: true
118-
options:
119-
- Windows
120-
- Linux
121-
- macOS
122-
- Other (please specify in steps to reproduce)
91+
label: Affected OS and version
92+
description: |
93+
What operating system are you using (e.g., `macOS Monterey 12.4`)?
94+
Please test using the latest version.
12395
validations:
12496
required: false
125-
12697
- type: dropdown
12798
id: build-tools
12899
attributes:
129100
label: Build and bundle tools
130-
description: What, if any, tools are used to build or bundle the project?
101+
description: |
102+
What, if any, tools are used to build or bundle the project?
103+
Please test using the latest version.
131104
multiple: true
132105
options:
133-
- Webpack
106+
- webpack
134107
- Rollup
135108
- esbuild
109+
- swc
136110
- Parcel
137-
- Create React App
138-
- Gatsby
111+
- CRA (Create React App)
112+
- Vite
139113
- Next.js
114+
- Remix
115+
- Astro
140116
- Docusaurus
141-
- Snowpack
142-
- Vite
117+
- Gatsby
143118
- Other (please specify in steps to reproduce)
144119
validations:
145120
required: false

0 commit comments

Comments
 (0)