Skip to content

Commit 30ffac4

Browse files
sapphi-redsapphi-red
authored
chore: add issue and pr templates (#18)
1 parent 4a24de4 commit 30ffac4

6 files changed

Lines changed: 172 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: "\U0001F41E Bug report"
2+
description: Report an issue with a plugin in this repository
3+
labels: [pending triage]
4+
type: Bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: checkboxes
11+
id: plugins
12+
attributes:
13+
label: Related plugins
14+
description: Select the plugin which is related
15+
options:
16+
- label: |
17+
[plugin-babel](https://github.com/rolldown/plugins/tree/main/packages/babel)
18+
- label: |
19+
[plugin-emotion](https://github.com/rolldown/plugins/tree/main/packages/emotion)
20+
- type: textarea
21+
id: bug-description
22+
attributes:
23+
label: Describe the bug
24+
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!
25+
placeholder: I am doing ... What I expect is ... What actually happening is ...
26+
validations:
27+
required: true
28+
- type: input
29+
id: reproduction
30+
attributes:
31+
label: Reproduction
32+
description: Please provide a link via [vite.new](https://vite.new/) or [Rolldown's stackblitz template](https://stackblitz.com/fork/github/rolldown/rolldown-starter-stackblitz) or a link to a repo that can reproduce the problem you ran into. `npm create vite@latest` and `npm create vite-extra@latest` (for SSR or library repros) can be used as a starter template. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "needs reproduction" label. If no reproduction is provided after 3 days, it will be auto-closed.
33+
placeholder: Reproduction URL
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: reproduction-steps
38+
attributes:
39+
label: Steps to reproduce
40+
description: Please provide any reproduction steps that may need to be described. E.g. if it happens only when running the dev or build script make sure it's clear which one to use.
41+
placeholder: Run `npm install` followed by `npm run dev`
42+
- type: textarea
43+
id: system-info
44+
attributes:
45+
label: System Info
46+
description: Output of `npx envinfo --system --npmPackages '{rolldown,@rolldown/*,vite,@vitejs/*}' --binaries --browsers`
47+
render: shell
48+
placeholder: System, Binaries, Browsers
49+
validations:
50+
required: true
51+
- type: dropdown
52+
id: package-manager
53+
attributes:
54+
label: Used Package Manager
55+
description: Select the used package manager
56+
options:
57+
- npm
58+
- yarn
59+
- pnpm
60+
- bun
61+
validations:
62+
required: true
63+
- type: checkboxes
64+
id: checkboxes
65+
attributes:
66+
label: Validations
67+
description: Before submitting the issue, please make sure you do the following
68+
options:
69+
- label: Follow our [Code of Conduct](https://github.com/rolldown/.github/blob/main/CODE_OF_CONDUCT.md)
70+
required: true
71+
- label: Check that there isn't [already an issue](https://github.com/rolldown/plugins/issues) that reports the same bug to avoid creating a duplicate.
72+
required: true
73+
- label: Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/rolldown/plugins/discussions).
74+
required: true
75+
- label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
76+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: Questions & Discussions
3+
url: https://github.com/rolldown/plugins/discussions
4+
about: Use GitHub discussions for message-board style questions and discussions.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: "\U0001F680 New feature proposal"
2+
description: Propose a new feature to be added to a plugin in this repository
3+
labels: ['pending triage']
4+
type: Feature
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for your interest in the project and taking the time to fill out this feature report!
10+
- type: checkboxes
11+
id: plugins
12+
attributes:
13+
label: Related plugins
14+
description: Select the plugin which is related
15+
options:
16+
- label: |
17+
[plugin-babel](https://github.com/rolldown/plugins/tree/main/packages/babel)
18+
- label: |
19+
[plugin-emotion](https://github.com/rolldown/plugins/tree/main/packages/emotion)
20+
- type: textarea
21+
id: feature-description
22+
attributes:
23+
label: Description
24+
description: 'Clear and concise description of the problem. Please make the reason and usecases as detailed as possible. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
25+
placeholder: As a developer using [plugin name] plugin, I want [goal / wish] so that [benefit].
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: suggested-solution
30+
attributes:
31+
label: Suggested solution
32+
description: 'In module [xy] we could provide following implementation...'
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: alternative
37+
attributes:
38+
label: Alternative
39+
description: Clear and concise description of any alternative solutions or features you've considered.
40+
- type: textarea
41+
id: additional-context
42+
attributes:
43+
label: Additional context
44+
description: Any other context or screenshots about the feature request here.
45+
- type: checkboxes
46+
id: checkboxes
47+
attributes:
48+
label: Validations
49+
description: Before submitting the issue, please make sure you do the following
50+
options:
51+
- label: Follow our [Code of Conduct](https://github.com/rolldown/.github/blob/main/CODE_OF_CONDUCT.md)
52+
required: true
53+
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
54+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!--
2+
- What is this PR solving? Write a clear and concise description.
3+
- Reference the issues it solves (e.g. `fixes #123`).
4+
- What other alternatives have you explored?
5+
- Are there any parts you think require more attention from reviewers?
6+
7+
Also, please make sure you do the following:
8+
9+
- Check that there isn't already a PR that solves the problem the same way. If you find a duplicate, please help us review it.
10+
- Update the corresponding documentation if needed.
11+
- Include relevant tests that fail without this PR but pass with it. If the tests are not included, explain why.
12+
13+
Thank you for contributing!
14+
-->

‎.github/labeler.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
'plugin: babel':
2+
- '/- \[x\] \[plugin-babel\]/i'
3+
'plugin: emotion':
4+
- '/- \[x\] \[plugin-emotion\]/i'

‎.github/workflows/issue-labeler.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Issue Labeler
2+
3+
on:
4+
issues:
5+
types: [opened, edited]
6+
7+
permissions:
8+
issues: write
9+
contents: read
10+
11+
jobs:
12+
label:
13+
runs-on: ubuntu-slim
14+
steps:
15+
- uses: github/issue-labeler@v3.4
16+
with:
17+
configuration-path: .github/labeler.yml
18+
enable-versioned-regex: 0
19+
sync-labels: 1
20+
repo-token: ${{ github.token }}

0 commit comments

Comments
 (0)