Skip to content

Commit 24303b3

Browse files
wooormwooorm
committed
Refactor templates
1 parent 822516a commit 24303b3

4 files changed

Lines changed: 131 additions & 113 deletions

File tree

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

Lines changed: 80 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
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
9-
* Is this really a problem?
10-
* Is this a problem here?
11-
* Can this be solved in a different way?
12-
- type: checkboxes
13-
id: initial-checklist
14-
attributes:
6+
* is this really a problem?
7+
* is this a problem here?
8+
* can this be solved in a different way?
9+
* can this be contributed as a PR with a failing test instead?
10+
type: markdown
11+
- attributes:
1512
label: Initial checklist
1613
options:
1714
- label: I read the [support docs](https://github.com/unifiedjs/.github/blob/main/support.md)
@@ -20,101 +17,105 @@ body:
2017
required: true
2118
- label: I agree to follow the [code of conduct](https://github.com/unifiedjs/.github/blob/main/code-of-conduct.md)
2219
required: true
23-
- label: I searched [issues](https://github.com/search?q=user%3Aunifiedjs&type=Issues) and couldn’t find anything (or linked relevant results below)
20+
- label: I searched [issues](https://github.com/search?q=user%3Aunifiedjs&type=issues) and [discussions](https://github.com/orgs/unifiedjs/discussions) and couldn’t find anything (or linked relevant results below)
2421
required: true
25-
- type: input
22+
id: initial-checklist
23+
type: checkboxes
24+
- attributes:
25+
description: |
26+
Which packages cause the bug?
27+
Please test using latest versions.
28+
Example: `some-package@1.2.3`.
29+
label: Affected package
2630
id: affected-versions
27-
attributes:
28-
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.
31+
type: input
3032
validations:
3133
required: true
32-
- type: input
33-
id: runnable-example
34-
attributes:
35-
label: Link to runnable example
34+
- attributes:
3635
description: |
37-
Link to repository or sandbox with runnable example of the issue.
38-
Alternatively, use the next section *Steps to reproduce*.
36+
How did this happen?
3937
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) |
47-
validations:
48-
required: false
49-
- type: textarea
50-
id: steps-to-reproduce
51-
attributes:
38+
Provide a [minimal and reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
39+
Link to a repository or sandbox or show the code here.
40+
Remove everything that is not needed.
41+
Use plain Node and npm if possible.
5242
label: Steps to reproduce
53-
description: How did this happen? Please provide a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
54-
validations:
55-
required: true
56-
- type: textarea
57-
id: expected-behavior
58-
attributes:
59-
label: Expected behavior
60-
description: What should happen?
43+
id: steps-to-reproduce
44+
type: textarea
6145
validations:
6246
required: true
63-
- type: textarea
64-
id: actual-behavior
65-
attributes:
47+
- attributes:
48+
description: |
49+
What happens?
50+
What is wrong with the current behavior?
6651
label: Actual behavior
67-
description: What happens instead?
52+
id: actual-behavior
53+
type: textarea
6854
validations:
6955
required: true
70-
- type: input
71-
id: runtime
72-
attributes:
73-
label: Affected runtime and version
56+
- attributes:
7457
description: |
75-
What runtime are you using (e.g., `node@18.2`, `deno@1.12.2`)?
76-
Please test using the latest version.
58+
What should happen instead?
59+
Why should that happen?
60+
Why is that better than the current behavior?
61+
label: Expected behavior
62+
id: expected-behavior
63+
type: textarea
7764
validations:
7865
required: true
79-
- type: input
80-
id: package-manager
81-
attributes:
82-
label: Affected package manager and version
66+
- attributes:
67+
label: Runtime
8368
description: |
84-
What package manager are you using (e.g., `npm@8.9.0`)?
85-
Please test using the latest version.
69+
What runtime are you using?
70+
Please test using latest versions.
71+
Example: `node@23.2.0` or `Chrome 131.0.6778.86`.
72+
id: runtime
73+
type: input
8674
validations:
8775
required: false
88-
- type: input
89-
id: operating-system
90-
attributes:
91-
label: Affected OS and version
76+
- attributes:
9277
description: |
93-
What operating system are you using (e.g., `macOS Monterey 12.4`)?
94-
Please test using the latest version.
78+
What package manager are you using?
79+
Please test using latest versions.
80+
Example: `npm@10.9.0`.
81+
label: Package manager
82+
id: package-manager
83+
type: input
9584
validations:
9685
required: false
97-
- type: dropdown
98-
id: build-tools
99-
attributes:
100-
label: Build and bundle tools
86+
- attributes:
10187
description: |
102-
What, if any, tools are used to build or bundle the project?
103-
Please test using the latest version.
88+
What operating system are you using?
89+
Please test using latest versions.
90+
Example: `macOS Sequoia 15.1.1`.
91+
label: Operating system
92+
id: operating-system
93+
type: input
94+
validations:
95+
required: false
96+
- attributes:
97+
description: |
98+
What tools are used to build or bundle the project?
99+
Please test using latest versions.
100+
label: Build and bundle tools
104101
multiple: true
105102
options:
106-
- webpack
107-
- Rollup
108-
- esbuild
109-
- swc
110-
- Parcel
111-
- CRA (Create React App)
112-
- Vite
113-
- Next.js
114-
- Remix
115103
- Astro
104+
- CRA (Create React App)
116105
- Docusaurus
117106
- Gatsby
118-
- Other (please specify in steps to reproduce)
107+
- Next.js
108+
- Parcel
109+
- Remix
110+
- Rollup
111+
- Vite
112+
- esbuild
113+
- swc
114+
- webpack
115+
- other (please specify in steps to reproduce)
116+
id: build-tools
117+
type: dropdown
119118
validations:
120119
required: false
120+
description: Report a bug
121+
name: 🐛 Bug

‎.github/ISSUE_TEMPLATE/2-feature.yml‎

Lines changed: 36 additions & 24 deletions
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
9-
* Is this really a problem?
10-
* Is this a problem here?
11-
- type: checkboxes
12-
id: initial-checklist
13-
attributes:
6+
* is this really a problem?
7+
* is this a problem here?
8+
type: markdown
9+
- attributes:
1410
label: Initial checklist
1511
options:
1612
- label: I read the [support docs](https://github.com/unifiedjs/.github/blob/main/support.md)
@@ -19,26 +15,42 @@ body:
1915
required: true
2016
- label: I agree to follow the [code of conduct](https://github.com/unifiedjs/.github/blob/main/code-of-conduct.md)
2117
required: true
22-
- label: I searched [issues](https://github.com/search?q=user%3Aunifiedjs&type=Issues) and couldn’t find anything (or linked relevant results below)
18+
- label: I searched [issues](https://github.com/search?q=user%3Aunifiedjs&type=issues) and [discussions](https://github.com/orgs/unifiedjs/discussions) and couldn’t find anything (or linked relevant results below)
2319
required: true
24-
- type: textarea
25-
id: problem
26-
attributes:
20+
id: initial-checklist
21+
type: checkboxes
22+
- attributes:
23+
description: |
24+
Please describe the problem.
25+
26+
Forget about the particular solution you have in mind.
27+
Solution time is later!
28+
29+
What is missing? What are the use cases?
30+
Describe which use cases are important and which are nice to have.
31+
Convince the maintainers that there is a real problem.
2732
label: Problem
28-
description: Please describe the problem you are trying to solve here.
33+
id: problem
34+
type: textarea
2935
validations:
3036
required: true
31-
- type: textarea
32-
id: solution
33-
attributes:
34-
label: Solution
35-
description: What should happen? Please describe the desired behavior.
37+
- attributes:
38+
description: |
39+
Are there existing solutions?
40+
Can these use cases be addressed already?
41+
label: Current solutions
42+
id: alternatives
43+
type: textarea
3644
validations:
3745
required: true
38-
- type: textarea
39-
id: alternatives
40-
attributes:
41-
label: Alternatives
42-
description: What are the alternative solutions? Can this be solved in a different way?
46+
- attributes:
47+
description: |
48+
What is a better solution?
49+
Why is that better than current solutions at addressing the use cases?
50+
label: Proposed solutions
51+
id: solution
52+
type: textarea
4353
validations:
4454
required: true
55+
description: Suggest an idea
56+
name: 🚀 Feature

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 3 additions & 3 deletions
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
4-
url: https://github.com/unifiedjs/unified/discussions
5-
about: Ask questions and discuss with other community members
3+
- about: Ask questions and discuss with other community members
4+
name: 💬 Discussions
5+
url: https://github.com/orgs/unifiedjs/discussions

‎.github/pull-request-template.md‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
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 do not show on GitHub.
4+
5+
Please try to limit the scope,
6+
provide a general description of the changes,
7+
and remember it’s up to you to convince us to land it.
8+
9+
We are excited about pull requests.
10+
Thank you!
711
-->
812

913
### Initial checklist
1014

1115
* [ ] I read the support docs <!-- https://github.com/unifiedjs/.github/blob/main/support.md -->
1216
* [ ] I read the contributing guide <!-- https://github.com/unifiedjs/.github/blob/main/contributing.md -->
1317
* [ ] I agree to follow the code of conduct <!-- https://github.com/unifiedjs/.github/blob/main/code-of-conduct.md -->
14-
* [ ] I searched issues and couldn’t find anything (or linked relevant results below) <!-- https://github.com/search?q=user%3Aunifiedjs&type=Issues -->
15-
* [ ] If applicable, I’ve added docs and tests
18+
* [ ] I searched issues and discussions and couldn’t find anything or linked relevant results below <!-- https://github.com/search?q=user%3Aunifiedjs&type=issues and https://github.com/orgs/unifiedjs/discussions -->
19+
* [ ] I made sure the docs are up to date
20+
* [ ] I included tests (or that’s not needed)
1621

1722
### Description of changes
1823

0 commit comments

Comments
 (0)