-
-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
650 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
name: "\U0001F41E Bug report" | ||
description: Report an issue with Vite | ||
labels: [pending triage] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: textarea | ||
id: bug-description | ||
attributes: | ||
label: Describe the bug | ||
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! | ||
placeholder: I am doing ... What I expect is ... What actually happening is ... | ||
validations: | ||
required: true | ||
- type: input | ||
id: reproduction | ||
attributes: | ||
label: Reproduction | ||
description: Please provide a link via [vite.new/react](https://vite.new/react) 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 "need reproduction" label. If no reproduction is provided after 3 days, it will be auto-closed. | ||
placeholder: Reproduction URL | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduction-steps | ||
attributes: | ||
label: Steps to reproduce | ||
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. | ||
placeholder: Run `npm install` followed by `npm run dev` | ||
- type: textarea | ||
id: system-info | ||
attributes: | ||
label: System Info | ||
description: Output of `npx envinfo --system --npmPackages '{vite,@vitejs/*}' --binaries --browsers` | ||
render: shell | ||
placeholder: System, Binaries, Browsers | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: package-manager | ||
attributes: | ||
label: Used Package Manager | ||
description: Select the used package manager | ||
options: | ||
- npm | ||
- yarn | ||
- pnpm | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Logs | ||
description: | | ||
Optional if provided reproduction. Please try not to insert an image but copy paste the log text. | ||
1. Run `vite` or `vite build` with the `--debug` flag. | ||
2. Provide the error log here in the format below. | ||
```` | ||
<details> | ||
<summary>Click to expand!</summary> | ||
```shell | ||
// paste the log text here | ||
``` | ||
</details> | ||
```` | ||
- type: checkboxes | ||
id: checkboxes | ||
attributes: | ||
label: Validations | ||
description: Before submitting the issue, please make sure you do the following | ||
options: | ||
- label: Follow our [Code of Conduct](https://github.com/vitejs/vite/blob/main/CODE_OF_CONDUCT.md) | ||
required: true | ||
- label: Read the [Contributing Guidelines](https://github.com/vitejs/vite/blob/main/CONTRIBUTING.md). | ||
required: true | ||
- label: Read the [docs](https://vitejs.dev/guide). | ||
required: true | ||
- label: Check that there isn't [already an issue](https://github.com/vitejs/vite/issues) that reports the same bug to avoid creating a duplicate. | ||
required: true | ||
- label: Make sure this is a Vite issue and not a framework-specific issue. For example, if it's a Vue SFC related bug, it should likely be reported to [vuejs/core](https://github.com/vuejs/core) instead. | ||
required: true | ||
- label: Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/vitejs/vite/discussions) or join our [Discord Chat Server](https://chat.vitejs.dev/). | ||
required: true | ||
- label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug. | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Discord Chat | ||
url: https://chat.vitejs.dev | ||
about: Ask questions and discuss with other Vite users in real time. | ||
- name: Questions & Discussions | ||
url: https://github.com/vitejs/vite/discussions | ||
about: Use GitHub discussions for message-board style questions and discussions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
name: "\U0001F680 New feature proposal" | ||
description: Propose a new feature to be added to Vite | ||
labels: ["enhancement: pending triage"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for your interest in the project and taking the time to fill out this feature report! | ||
- type: textarea | ||
id: feature-description | ||
attributes: | ||
label: Description | ||
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!" | ||
placeholder: As a developer using Vite I want [goal / wish] so that [benefit]. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: suggested-solution | ||
attributes: | ||
label: Suggested solution | ||
description: "In module [xy] we could provide following implementation..." | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: alternative | ||
attributes: | ||
label: Alternative | ||
description: Clear and concise description of any alternative solutions or features you've considered. | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Any other context or screenshots about the feature request here. | ||
- type: checkboxes | ||
id: checkboxes | ||
attributes: | ||
label: Validations | ||
description: Before submitting the issue, please make sure you do the following | ||
options: | ||
- label: Follow our [Code of Conduct](https://github.com/vitejs/vite/blob/main/CODE_OF_CONDUCT.md) | ||
required: true | ||
- label: Read the [Contributing Guidelines](https://github.com/vitejs/vite/blob/main/CONTRIBUTING.md). | ||
required: true | ||
- label: Read the [docs](https://vitejs.dev/guide). | ||
required: true | ||
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- Thank you for contributing! --> | ||
|
||
### Description | ||
|
||
<!-- Please insert your description here and provide especially info about the "what" this PR is solving --> | ||
|
||
### Additional context | ||
|
||
<!-- e.g. is there anything you'd like reviewers to focus on? --> | ||
|
||
--- | ||
|
||
### What is the purpose of this pull request? <!-- (put an "X" next to an item) --> | ||
|
||
- [ ] Bug fix | ||
- [ ] New Feature | ||
- [ ] Documentation update | ||
- [ ] Other | ||
|
||
### Before submitting the PR, please make sure you do the following | ||
|
||
- [ ] Read the [Contributing Guidelines](https://github.com/vitejs/vite/blob/main/CONTRIBUTING.md). | ||
- [ ] Read the [Pull Request Guidelines](https://github.com/vitejs/vite/blob/main/CONTRIBUTING.md#pull-request-guidelines) and follow the [Commit Convention](https://github.com/vitejs/vite/blob/main/.github/commit-convention.md). | ||
- [ ] Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate. | ||
- [ ] Provide a description in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`). | ||
- [ ] Ideally, include relevant tests that fail without this PR but pass with it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
## Git Commit Message Convention | ||
|
||
> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular). | ||
#### TL;DR: | ||
|
||
Messages must be matched by the following regex: | ||
|
||
<!-- prettier-ignore --> | ||
```js | ||
/^(revert: )?(feat|fix|docs|dx|refactor|perf|test|workflow|build|ci|chore|types|wip|release|deps)(\(.+\))?: .{1,50}/ | ||
``` | ||
|
||
#### Examples | ||
|
||
Appears under "Features" header, `dev` subheader: | ||
|
||
``` | ||
feat(dev): add 'comments' option | ||
``` | ||
|
||
Appears under "Bug Fixes" header, `dev` subheader, with a link to issue #28: | ||
|
||
``` | ||
fix(dev): fix dev error | ||
close #28 | ||
``` | ||
|
||
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation: | ||
|
||
``` | ||
perf(build): remove 'foo' option | ||
BREAKING CHANGE: The 'foo' option has been removed. | ||
``` | ||
|
||
The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header. | ||
|
||
``` | ||
revert: feat(compiler): add 'comments' option | ||
This reverts commit 667ecc1654a317a13331b17617d973392f415f02. | ||
``` | ||
|
||
### Full Message Format | ||
|
||
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**: | ||
|
||
``` | ||
<type>(<scope>): <subject> | ||
<BLANK LINE> | ||
<body> | ||
<BLANK LINE> | ||
<footer> | ||
``` | ||
|
||
The **header** is mandatory and the **scope** of the header is optional. | ||
|
||
### Revert | ||
|
||
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted. | ||
|
||
### Type | ||
|
||
If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog. | ||
|
||
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks. | ||
|
||
### Scope | ||
|
||
The scope could be anything specifying the place of the commit change. For example `dev`, `build`, `workflow`, `cli` etc... | ||
|
||
### Subject | ||
|
||
The subject contains a succinct description of the change: | ||
|
||
- use the imperative, present tense: "change" not "changed" nor "changes" | ||
- don't capitalize the first letter | ||
- no dot (.) at the end | ||
|
||
### Body | ||
|
||
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". | ||
The body should include the motivation for the change and contrast this with previous behavior. | ||
|
||
### Footer | ||
|
||
The footer should contain any information about **Breaking Changes** and is also the place to | ||
reference GitHub issues that this commit **Closes**. | ||
|
||
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
{ | ||
"extends": ["config:base", "schedule:weekly", "group:allNonMajor"], | ||
"labels": ["dependencies"], | ||
"ignorePaths": ["**/__tests__/**"], | ||
"pin": false, | ||
"rangeStrategy": "bump", | ||
"node": false, | ||
"packageRules": [ | ||
{ | ||
"depTypeList": ["peerDependencies"], | ||
"enabled": false | ||
} | ||
], | ||
"ignoreDeps": [ | ||
// manually bumping | ||
"esbuild", | ||
"rollup", | ||
"node", | ||
"typescript", | ||
|
||
// breaking changes | ||
"source-map", // `source-map:v0.7.0+` needs more investigation | ||
"dotenv-expand", // `dotenv-expand:6.0.0+` has breaking changes (#6858) | ||
"kill-port", // `kill-port:^2.0.0 has perf issues (#8392) | ||
"miniflare" // `miniflare:v2.0.0+` only supports node 16.7 | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
titleOnly: true | ||
types: | ||
- feat | ||
- fix | ||
- docs | ||
- dx | ||
- refactor | ||
- perf | ||
- test | ||
- workflow | ||
- build | ||
- ci | ||
- chore | ||
- types | ||
- wip | ||
- release | ||
- deps |
Oops, something went wrong.