Skip to content

Commit b44957d

Browse files
committed
chore: improve community health
1 parent c6ffaed commit b44957d

File tree

5 files changed

+150
-0
lines changed

5 files changed

+150
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: 🐞 Bug report
2+
description: Report an issue
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: textarea
10+
id: bug-description
11+
attributes:
12+
label: Describe the bug
13+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
14+
placeholder: Bug description
15+
validations:
16+
required: true
17+
- type: input
18+
id: reproduction
19+
attributes:
20+
label: Reproduction
21+
description: A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is **required**, otherwise the issue might be closed without further notice. [**Why & How?**](https://antfu.me/posts/why-reproductions-are-required)
22+
placeholder: Reproduction
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: system-info
27+
attributes:
28+
label: System Info
29+
description: Output of `npx envinfo --system --binaries --browsers`
30+
render: Shell
31+
placeholder: System, Binaries, Browsers
32+
validations:
33+
required: true
34+
- type: dropdown
35+
id: package-manager
36+
attributes:
37+
label: Used Package Manager
38+
description: Select the used package manager
39+
options:
40+
- npm
41+
- yarn
42+
- pnpm
43+
- bun
44+
- n/a
45+
validations:
46+
required: true
47+
- type: checkboxes
48+
id: checkboxes
49+
attributes:
50+
label: Validations
51+
description: Before submitting the issue, please make sure you do the following
52+
options:
53+
- label: Follow our [Code of Conduct](https://github.com/antfu/.github/blob/main/CODE_OF_CONDUCT.md)
54+
required: true
55+
- label: Read the [Contributing Guide](https://devtools-next.vuejs.org/help/contributing).
56+
required: true
57+
- label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
58+
required: true
59+
- label: Check that this is a concrete bug. For Q&A, please open a GitHub Discussion instead.
60+
required: true
61+
- label: The provided reproduction is a [minimal reproducible](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
62+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
contact_links:
2+
- name: 🙌 Contribution Guide
3+
url: https://devtools-next.vuejs.org/help/contributing
4+
about: Please read through before making contributions.
5+
- name: ⁉️ Why and How to make a reproduction?
6+
url: https://antfu.me/posts/why-reproductions-are-required
7+
about: Reproduction is very important for maintainer to help on your issues!
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: 🚀 New feature proposal
2+
description: Propose a new feature
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for your interest in the project and taking the time to fill out this feature report!
9+
- type: textarea
10+
id: feature-description
11+
attributes:
12+
label: Clear and concise description of the problem
13+
description: 'As a developer using Unplugin I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: suggested-solution
18+
attributes:
19+
label: Suggested solution
20+
description: 'In module [xy] we could provide following implementation...'
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: alternative
25+
attributes:
26+
label: Alternative
27+
description: Clear and concise description of any alternative solutions or features you've considered.
28+
- type: textarea
29+
id: additional-context
30+
attributes:
31+
label: Additional context
32+
description: Any other context or screenshots about the feature request here.
33+
- type: checkboxes
34+
id: checkboxes
35+
attributes:
36+
label: Validations
37+
description: Before submitting the issue, please make sure you do the following
38+
options:
39+
- label: Follow our [Code of Conduct](https://github.com/antfu/.github/blob/main/CODE_OF_CONDUCT.md)
40+
required: true
41+
- label: Read the [Contributing Guide](https://devtools-next.vuejs.org/help/contributing).
42+
required: true
43+
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
44+
required: true

.github/ISSUE_TEMPLATE/typo.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: 👀 Typo / Grammar fix
2+
description: You can just go ahead and send a PR! Thank you!
3+
labels: []
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## PR Welcome!
9+
10+
If the typo / grammar issue is trivial and straightforward, you can help by **directly sending a quick pull request**!
11+
If you spot multiple of them, we suggest combining them into a single PR. Thanks!
12+
- type: textarea
13+
id: context
14+
attributes:
15+
label: Additional context

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- DO NOT IGNORE THE TEMPLATE!
2+
3+
Thank you for contributing!
4+
5+
Before submitting the PR, please make sure you do the following:
6+
7+
- Read the [Contributing Guide](https://devtools-next.vuejs.org/help/contributing).
8+
- Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
9+
- Provide a description in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`).
10+
- Ideally, include relevant tests that fail without this PR but pass with it.
11+
12+
-->
13+
14+
### Description
15+
16+
<!-- Please insert your description here and provide especially info about the "what" this PR is solving -->
17+
18+
### Linked Issues
19+
20+
### Additional context
21+
22+
<!-- e.g. is there anything you'd like reviewers to focus on? -->

0 commit comments

Comments
 (0)