Skip to content

Commit 6a07132

Browse files
wooormwooorm
committed
Refactor issue templates
1 parent eaba6e9 commit 6a07132

File tree

4 files changed

+89
-89
lines changed

4 files changed

+89
-89
lines changed

‎.github/ISSUE_TEMPLATE/1-bug.yml

+59-63
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
name: 🐛 Bug report
2-
description: Describe a bug with a project
31
body:
4-
- type: markdown
5-
attributes:
2+
- attributes:
63
value: |
74
Some general tips:
85
96
* Is this really a problem?
107
* Is this a problem here?
118
* Can this be solved in a different way?
12-
- type: checkboxes
13-
id: initial-checklist
14-
attributes:
9+
type: markdown
10+
- attributes:
1511
label: Initial checklist
1612
options:
1713
- label: I read the [support docs](https://github.com/vfile/.github/blob/main/support.md)
@@ -22,99 +18,99 @@ body:
2218
required: true
2319
- label: I searched [issues](https://github.com/search?q=user%3Avfile&type=Issues) and couldn’t find anything (or linked relevant results below)
2420
required: true
25-
- type: input
26-
id: affected-versions
27-
attributes:
21+
id: initial-checklist
22+
type: checkboxes
23+
- attributes:
24+
description: |
25+
Please test using the latest version of the relevant packages to make
26+
sure your issue has not already been fixed.
2827
label: Affected packages and versions
29-
description: Please test using the latest version of the relevant packages to make sure your issue has not already been fixed.
28+
id: affected-versions
29+
type: input
3030
validations:
3131
required: true
32-
- type: input
33-
id: runnable-example
34-
attributes:
35-
label: Link to runnable example
32+
- attributes:
3633
description: |
3734
Link to repository or sandbox with runnable example of the issue.
3835
Alternatively, use the next section *Steps to reproduce*.
39-
40-
Some starters:
41-
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) |
36+
label: Link to runnable example
37+
id: runnable-example
38+
type: input
4739
validations:
4840
required: false
49-
- type: textarea
50-
id: steps-to-reproduce
51-
attributes:
41+
- attributes:
42+
description: |
43+
How did this happen?
44+
Please provide a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
5245
label: Steps to reproduce
53-
description: How did this happen? Please provide a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
46+
id: steps-to-reproduce
47+
type: textarea
5448
validations:
5549
required: true
56-
- type: textarea
57-
id: expected-behavior
58-
attributes:
59-
label: Expected behavior
50+
- attributes:
6051
description: What should happen?
52+
label: Expected behavior
53+
id: expected-behavior
54+
type: textarea
6155
validations:
6256
required: true
63-
- type: textarea
64-
id: actual-behavior
65-
attributes:
66-
label: Actual behavior
57+
- attributes:
6758
description: What happens instead?
59+
label: Actual behavior
60+
id: actual-behavior
61+
type: textarea
6862
validations:
6963
required: true
70-
- type: input
71-
id: runtime
72-
attributes:
64+
- attributes:
7365
label: Affected runtime and version
7466
description: |
75-
What runtime are you using (e.g., `[email protected]`, `[email protected]`)?
67+
What runtime are you using (such as `[email protected]`, `[email protected]`)?
7668
Please test using the latest version.
69+
id: runtime
70+
type: input
7771
validations:
7872
required: true
79-
- type: input
80-
id: package-manager
81-
attributes:
82-
label: Affected package manager and version
73+
- attributes:
8374
description: |
84-
What package manager are you using (e.g., `[email protected]`)?
75+
What package manager are you using (such as `[email protected]`)?
8576
Please test using the latest version.
77+
label: Affected package manager and version
78+
id: package-manager
79+
type: input
8680
validations:
8781
required: false
88-
- type: input
89-
id: operating-system
90-
attributes:
91-
label: Affected OS and version
82+
- attributes:
9283
description: |
93-
What operating system are you using (e.g., `macOS Monterey 12.4`)?
84+
What operating system are you using (such as `macOS Monterey 12.4`)?
9485
Please test using the latest version.
86+
label: Affected OS and version
87+
id: operating-system
88+
type: input
9589
validations:
9690
required: false
97-
- type: dropdown
98-
id: build-tools
99-
attributes:
100-
label: Build and bundle tools
91+
- attributes:
10192
description: |
10293
What, if any, tools are used to build or bundle the project?
10394
Please test using the latest version.
95+
label: Build and bundle tools
10496
multiple: true
10597
options:
106-
- webpack
107-
- Rollup
108-
- esbuild
109-
- swc
110-
- Parcel
111-
- CRA (Create React App)
112-
- Vite
113-
- Next.js
114-
- Remix
11598
- Astro
99+
- CRA (Create React App)
116100
- Docusaurus
117101
- Gatsby
118-
- Other (please specify in steps to reproduce)
102+
- Next.js
103+
- Parcel
104+
- Remix
105+
- Rollup
106+
- Vite
107+
- esbuild
108+
- swc
109+
- webpack
110+
- other (please specify in steps to reproduce)
111+
id: build-tools
112+
type: dropdown
119113
validations:
120114
required: false
115+
description: Describe a bug with a project
116+
name: 🐛 Bug report

‎.github/ISSUE_TEMPLATE/2-feature.yml

+23-19
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
name: 🚀 Feature request
2-
description: Suggest an idea
31
body:
4-
- type: markdown
5-
attributes:
2+
- attributes:
63
value: |
74
Some general tips:
85
96
* Is this really a problem?
107
* Is this a problem here?
11-
- type: checkboxes
12-
id: initial-checklist
13-
attributes:
8+
type: markdown
9+
- attributes:
1410
label: Initial checklist
1511
options:
1612
- label: I read the [support docs](https://github.com/vfile/.github/blob/main/support.md)
@@ -21,24 +17,32 @@ body:
2117
required: true
2218
- label: I searched [issues](https://github.com/search?q=user%3Avfile&type=Issues) and couldn’t find anything (or linked relevant results below)
2319
required: true
24-
- type: textarea
25-
id: problem
26-
attributes:
27-
label: Problem
20+
id: initial-checklist
21+
type: checkboxes
22+
- attributes:
2823
description: Please describe the problem you are trying to solve here.
24+
label: Problem
25+
id: problem
26+
type: textarea
2927
validations:
3028
required: true
31-
- type: textarea
32-
id: solution
33-
attributes:
29+
- attributes:
30+
description: |
31+
What should happen?
32+
Please describe the desired behavior.
3433
label: Solution
35-
description: What should happen? Please describe the desired behavior.
34+
id: solution
35+
type: textarea
3636
validations:
3737
required: true
38-
- type: textarea
39-
id: alternatives
40-
attributes:
38+
- attributes:
39+
description: |
40+
What are the alternative solutions?
41+
Can this be solved in a different way?
4142
label: Alternatives
42-
description: What are the alternative solutions? Can this be solved in a different way?
43+
id: alternatives
44+
type: textarea
4345
validations:
4446
required: true
47+
description: Suggest an idea
48+
name: 🚀 Feature request

‎.github/ISSUE_TEMPLATE/config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: 🙋 Ask a question
3+
- about: Ask questions and discuss with other community members
4+
name: 🙋 Ask a question
45
url: https://github.com/vfile/vfile/discussions
5-
about: Ask questions and discuss with other community members

‎.github/pull-request-template.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!--
2-
Please check the needed checkboxes ([ ] -> [x]). Leave the
3-
comments as they are, they won’t show on GitHub.
4-
We are excited about pull requests, but please try to limit the scope, provide
5-
a general description of the changes, and remember, it’s up to you to convince
6-
us to land it.
2+
Please check the needed checkboxes ([ ] -> [x]).
3+
Leave the comments as they are, they won’t show on GitHub.
4+
We are excited about pull requests, but please try to limit the scope,
5+
provide a general description of the changes, and remember, it’s up to you to
6+
convince us to land it.
77
-->
88

99
### Initial checklist

0 commit comments

Comments
 (0)