Skip to content

Commit cb69208

Browse files
authored
chore: issues forms (#5145)
1 parent 9329feb commit cb69208

File tree

4 files changed

+142
-3
lines changed

4 files changed

+142
-3
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: "\U0001F41E Bug report"
2+
description: Create a report to help us improve
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
**Before You Start...**
8+
9+
This form is only for submitting bug reports. If you have a usage question
10+
or are unsure if this is really a bug, make sure to:
11+
12+
- Read the [docs](https://vuejs.org/)
13+
- Ask on [Discord Chat](https://chat.vuejs.org/)
14+
- Ask on [GitHub Discussions](https://github.com/vuejs/core/discussions)
15+
- Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/ask?tags=vue.js)
16+
17+
Also try to search for your issue - it may have already been answered or even fixed in the development branch.
18+
However, if you find that an old, closed issue still persists in the latest version,
19+
you should open a new issue using the form below instead of commenting on the old issue.
20+
- type: input
21+
id: reproduction-link
22+
attributes:
23+
label: Link to minimal reproduction
24+
description: |
25+
The easiest way to provide a reproduction is by showing the bug in [The SFC Playground](https://sfc.vuejs.org/).
26+
If it cannot be reproduced in the playground and requires a proper build setup, try [StackBlitz](https://vite.new/vue).
27+
If neither of these are suitable, you can always provide a GitHub reporistory.
28+
29+
The reproduction should be **minimal** - i.e. it should contain only the bare minimum amount of code needed
30+
to show the bug. See [Bug Reproduction Guidelines](https://github.com/vuejs/core/blob/main/.github/bug-repro-guidelines.md) for more details.
31+
32+
Please do not just fill in a random link. The issue will be closed if no valid reproduction is provided.
33+
placeholder: Reproduction Link
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: steps-to-reproduce
38+
attributes:
39+
label: Steps to reproduce
40+
description: |
41+
What do we need to do after opening your repro in order to make the bug happen? Clear and concise reproduction instructions are important for us to be able to triage your issue in a timely manner. Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format lists and code.
42+
placeholder: Steps to reproduce
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: expected
47+
attributes:
48+
label: What is expected?
49+
validations:
50+
required: true
51+
- type: textarea
52+
id: actually-happening
53+
attributes:
54+
label: What is actually happening?
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: system-info
59+
attributes:
60+
label: System Info
61+
description: Output of `npx envinfo --system --npmPackages vue --binaries --browsers`
62+
render: shell
63+
placeholder: System, Binaries, Browsers
64+
- type: textarea
65+
id: additional-comments
66+
attributes:
67+
label: Any additional comments?
68+
description: e.g. some background/context of how you ran into this bug.

.github/ISSUE_TEMPLATE/config.yml

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: Create new issue
4-
url: https://new-issue.vuejs.org/?repo=vuejs/core
5-
about: Please use the following link to create a new issue.
3+
- name: Discord Chat
4+
url: https://chat.vuejs.org
5+
about: Ask questions and discuss with other Vue users in real time.
6+
- name: Questions & Discussions
7+
url: https://github.com/vuejs/core/discussions
8+
about: Use GitHub discussions for message-board style questions and discussions.
69
- name: Patreon
710
url: https://www.patreon.com/evanyou
811
about: Love Vue.js? Please consider supporting us via Patreon.
+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: "\U0001F680 New feature proposal"
2+
description: Suggest an idea for this project
3+
labels: [":sparkles: feature request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Before You Start...**
9+
10+
This form is only for submitting feature requests. If you have a usage question
11+
or are unsure if this is really a bug, make sure to:
12+
13+
- Read the [docs](https://vuejs.org/)
14+
- Ask on [Discord Chat](https://chat.vuejs.org/)
15+
- Ask on [GitHub Discussions](https://github.com/vuejs/core/discussions)
16+
- Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/ask?tags=vue.js)
17+
18+
Also try to search for your issue - another user may have already requested something similar!
19+
20+
- type: textarea
21+
id: problem-description
22+
attributes:
23+
label: What problem does this feature solve?
24+
description: |
25+
Explain your use case, context, and rationale behind this feature request. More importantly, what is the **end user experience** you are trying to build that led to the need for this feature?
26+
27+
An important design goal of Vue is keeping the API surface small and straightforward. In general, we only consider adding new features that solve a problem that cannot be easily dealt with using existing APIs (i.e. not just an alternative way of doing things that can already be done). The problem should also be common enough to justify the addition.
28+
placeholder: Problem description
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: proposed-API
33+
attributes:
34+
label: What does the proposed API look like?
35+
description: |
36+
Describe how you propose to solve the problem and provide code samples of how the API would work once implemented. Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format your code blocks.
37+
placeholder: Steps to reproduce
38+
validations:
39+
required: true

.github/bug-repro-guidelines.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## About Bug Reproductions
2+
3+
A bug reproduction is a piece of code that can run and demonstrate how a bug can happen.
4+
5+
### Text is not enough
6+
7+
It's impossible to fix a bug from mere text descriptions. First, it's very difficult to precisely describe a technical problem while keeping it easy to follow; Second, the real cause may very well be something that you forgot to even mention. A reproduction is the only way that can reliably help us understand what is going on, so please provide one.
8+
9+
### A repro must be runnable
10+
11+
Screenshots or videos are NOT reproductions! They only show that the bug exists, but do not provide enough information on why it happens. Only runnable code provides the most complete context and allows us to properly debug the scenario. That said, in some cases videos/gifs can help explain interaction issues that are hard to describe in text.
12+
13+
### A repro should be minimal
14+
15+
Some users would give us a link to a real project and hope we can help them figure out what is wrong. We generally do not accept such requests because:
16+
17+
You are already familiar with your codebase, but we are not. It is extremely time-consuming to hunt a bug in a big and unfamiliar codebase.
18+
19+
The problematic behavior may very well be caused by your code rather than by a bug in Vue.
20+
21+
A minimal reproduction means it demonstrates the bug, and the bug only. It should only contain the bare minimum amount of code that can reliably cause the bug. Try your best to get rid of anything that aren't directly related to the problem.
22+
23+
### How to create a repro
24+
25+
For Vue 3 core reproductions, try reproducing it in [The SFC Playground](https://sfc.vuejs.org/).
26+
27+
If it cannot be reproduced in the playground and requires a proper build setup, try [StackBlitz](https://vite.new/vue).
28+
29+
If neither of these are suitable, you can always provide a GitHub repository.

0 commit comments

Comments
 (0)