Skip to content

Commit 027404d

Browse files
cpojercpojer
authored
chore: Issue templates and update CONTRIBUTING.md. (#727)
Adds issue templates inspired by Vite, including links to other tools. Also updates the contributing guide with a guide for setting up verified commits.
1 parent b8cd9b7 commit 027404d

5 files changed

Lines changed: 222 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: "\U0001F41E Bug report"
2+
description: Report an issue with Vite+
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+
11+
Please only file issues here if the bug is in Vite+ itself.
12+
If the bug belongs to an underlying tool, report it in that project's tracker (linked in the "Create new issue" page).
13+
- type: textarea
14+
id: bug-description
15+
attributes:
16+
label: Describe the bug
17+
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.
18+
placeholder: I am doing ... What I expect is ... What is actually happening is ...
19+
validations:
20+
required: true
21+
- type: input
22+
id: reproduction
23+
attributes:
24+
label: Reproduction
25+
description: Please provide a link to a minimal reproduction repository or a runnable stackblitz/sandbox. If a report is vague and has no reproduction, it may be closed.
26+
placeholder: Reproduction URL
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: reproduction-steps
31+
attributes:
32+
label: Steps to reproduce
33+
description: Provide any required steps, commands, or setup details.
34+
placeholder: Run `pnpm install` followed by `vp dev`
35+
- type: textarea
36+
id: system-info
37+
attributes:
38+
label: System Info
39+
description: |
40+
Paste the full output of both commands:
41+
- `vp env current`
42+
- `vp --version`
43+
render: shell
44+
placeholder: Paste `vp env current` and `vp --version` output here
45+
validations:
46+
required: true
47+
- type: dropdown
48+
id: package-manager
49+
attributes:
50+
label: Used Package Manager
51+
description: Select the package manager used in your project
52+
options:
53+
- npm
54+
- yarn
55+
- pnpm
56+
- bun
57+
validations:
58+
required: true
59+
- type: textarea
60+
id: logs
61+
attributes:
62+
label: Logs
63+
description: |
64+
Optional when a reproduction is provided. Please copy-paste text logs instead of screenshots.
65+
66+
If relevant, run your command with `--debug` and include the output.
67+
render: shell
68+
- type: checkboxes
69+
id: checkboxes
70+
attributes:
71+
label: Validations
72+
description: Before submitting the issue, please confirm the following
73+
options:
74+
- label: Read the [Contributing Guidelines](https://github.com/voidzero-dev/vite-plus/blob/main/CONTRIBUTING.md).
75+
required: true
76+
- label: Check that there isn't [already an issue](https://github.com/voidzero-dev/vite-plus/issues) for the same bug.
77+
required: true
78+
- label: Confirm this is a Vite+ issue and not an upstream issue (Vite, Vitest, tsdown, Rolldown, or Oxc).
79+
required: true
80+
- label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
81+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Vite Issues
4+
url: https://github.com/vitejs/vite/issues/new/choose
5+
about: Report issues specific to Vite core in the Vite repository.
6+
- name: Vitest Issues
7+
url: https://github.com/vitest-dev/vitest/issues/new/choose
8+
about: Report issues specific to Vitest in the Vitest repository.
9+
- name: tsdown Issues
10+
url: https://github.com/rolldown/tsdown/issues/new/choose
11+
about: Report issues specific to tsdown in the tsdown repository.
12+
- name: Rolldown Issues
13+
url: https://github.com/rolldown/rolldown/issues/new/choose
14+
about: Report issues specific to Rolldown in the Rolldown repository.
15+
- name: Oxc (Oxlint/Oxfmt) Issues
16+
url: https://github.com/oxc-project/oxc/issues/new/choose
17+
about: Report Oxlint/Oxfmt issues in the Oxc repository.

‎.github/ISSUE_TEMPLATE/docs.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: "\U0001F4DA Documentation"
2+
description: Suggest a documentation improvement for Vite+
3+
labels: [documentation]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this issue.
9+
- type: checkboxes
10+
id: documentation_is
11+
attributes:
12+
label: Documentation is
13+
options:
14+
- label: Missing
15+
- label: Outdated
16+
- label: Confusing
17+
- label: Not sure
18+
- type: textarea
19+
id: description
20+
attributes:
21+
label: Explain in Detail
22+
description: A clear and concise description of your suggestion. If you intend to submit a PR for this issue, mention it here.
23+
placeholder: The description of ... is not clear. I thought it meant ... but it wasn't.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: suggestion
28+
attributes:
29+
label: Your Suggestion for Changes
30+
validations:
31+
required: true
32+
- type: input
33+
id: reference
34+
attributes:
35+
label: Relevant Page
36+
description: Link to the relevant doc page, section, or file.
37+
placeholder: https://github.com/voidzero-dev/vite-plus/blob/main/docs/...
38+
- type: input
39+
id: reproduction
40+
attributes:
41+
label: Reproduction (Optional)
42+
description: If the docs issue is tied to behavior, share a minimal reproduction link.
43+
placeholder: Reproduction URL
44+
- type: textarea
45+
id: reproduction-steps
46+
attributes:
47+
label: Steps to reproduce (Optional)
48+
description: Add steps if the docs issue is about incorrect behavior guidance.
49+
placeholder: Run `pnpm install` followed by `vp dev`

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: "\U0001F680 New feature proposal"
2+
description: Propose a new feature to be added to Vite+
3+
labels: [pending triage]
4+
type: Feature
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for your interest in Vite+ and taking the time to fill out this feature report.
10+
11+
Please only open feature proposals here for Vite+ itself.
12+
If the proposal belongs to an underlying tool, use that project's tracker (linked in the "Create new issue" page).
13+
- type: textarea
14+
id: feature-description
15+
attributes:
16+
label: Description
17+
description: 'Clear and concise description of the problem. Explain use cases and motivation. If you intend to submit a PR for this issue, mention it here.'
18+
placeholder: As a developer using Vite+ I want [goal / wish] so that [benefit].
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: suggested-solution
23+
attributes:
24+
label: Suggested solution
25+
description: 'Describe a possible API, behavior, or implementation direction.'
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: alternative
30+
attributes:
31+
label: Alternative
32+
description: Describe any alternative solutions or features you've considered.
33+
- type: textarea
34+
id: additional-context
35+
attributes:
36+
label: Additional context
37+
description: Any other context, links, or screenshots about the feature request.
38+
- type: checkboxes
39+
id: checkboxes
40+
attributes:
41+
label: Validations
42+
description: Before submitting the issue, please confirm the following
43+
options:
44+
- label: Read the [Contributing Guidelines](https://github.com/voidzero-dev/vite-plus/blob/main/CONTRIBUTING.md).
45+
required: true
46+
- label: Confirm this request is for Vite+ itself and not for Vite, Vitest, tsdown, Rolldown, or Oxc.
47+
required: true
48+
- label: Check that there isn't already an issue requesting the same feature.
49+
required: true

‎CONTRIBUTING.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,32 @@ pnpm -F vite-plus snap-test-global <name-filter>
6565

6666
Snap tests auto-generate `snap.txt` files. Check `git diff` to verify output changes are correct.
6767

68+
## Verified Commits
69+
70+
All commits in PR branches should be GitHub-verified so reviewers can confirm commit authenticity.
71+
72+
Set up local commit signing and GitHub verification first:
73+
74+
- Follow GitHub's guide for GPG commit signature verification: https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#gpg-commit-signature-verification
75+
- If you use Graphite, add the Graphite GPG key to your GitHub account from the Graphite UI as well, otherwise commits updated by Graphite won't show as verified.
76+
77+
After setup, re-sign any existing commits in your branch so the full branch is verified:
78+
79+
```bash
80+
# Re-sign each commit on your branch (replace origin/main with your branch base if needed)
81+
git rebase -i origin/main
82+
# At each stop:
83+
git commit --amend --date=now --no-edit -S
84+
# Then continue:
85+
git rebase --continue
86+
```
87+
88+
When done, force-push the updated branch history:
89+
90+
```bash
91+
git push --force-with-lease
92+
```
93+
6894
## Pull upstream dependencies
6995

7096
> [!NOTE]

0 commit comments

Comments
 (0)