You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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: version
22
+
attributes:
23
+
label: Vue version
24
+
validations:
25
+
required: true
26
+
- type: input
27
+
id: reproduction-link
28
+
attributes:
29
+
label: Link to minimal reproduction
30
+
description: |
31
+
The easiest way to provide a reproduction is by showing the bug in [The SFC Playground](https://sfc.vuejs.org/).
32
+
If it cannot be reproduced in the playground and requires a proper build setup, try [StackBlitz](https://vite.new/vue).
33
+
If neither of these are suitable, you can always provide a GitHub reporistory.
34
+
35
+
The reproduction should be **minimal** - i.e. it should contain only the bare minimum amount of code needed
36
+
to show the bug. See [Bug Reproduction Guidelines](https://github.com/vuejs/core/blob/main/.github/bug-repro-guidelines.md) for more details.
37
+
38
+
Please do not just fill in a random link. The issue will be closed if no valid reproduction is provided.
39
+
placeholder: Reproduction Link
40
+
validations:
41
+
required: true
42
+
- type: textarea
43
+
id: steps-to-reproduce
44
+
attributes:
45
+
label: Steps to reproduce
46
+
description: |
47
+
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.
48
+
placeholder: Steps to reproduce
49
+
validations:
50
+
required: true
51
+
- type: textarea
52
+
id: expected
53
+
attributes:
54
+
label: What is expected?
55
+
validations:
56
+
required: true
57
+
- type: textarea
58
+
id: actually-happening
59
+
attributes:
60
+
label: What is actually happening?
61
+
validations:
62
+
required: true
63
+
- type: textarea
64
+
id: system-info
65
+
attributes:
66
+
label: System Info
67
+
description: Output of `npx envinfo --system --npmPackages vue --binaries --browsers`
68
+
render: shell
69
+
placeholder: System, Binaries, Browsers
70
+
- type: textarea
71
+
id: additional-comments
72
+
attributes:
73
+
label: Any additional comments?
74
+
description: e.g. some background/context of how you ran into this bug.
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.
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.
Copy file name to clipboardExpand all lines: .github/contributing.md
+15-8Lines changed: 15 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Hi! I'm really excited that you are interested in contributing to Vue.js. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
4
4
5
-
-[Code of Conduct](https://github.com/vuejs/vue/blob/dev/.github/CODE_OF_CONDUCT.md)
5
+
-[Code of Conduct](https://vuejs.org/about/coc.html)
@@ -17,7 +17,9 @@ Hi! I'm really excited that you are interested in contributing to Vue.js. Before
17
17
18
18
## Pull Request Guidelines
19
19
20
-
- Checkout a topic branch from a base branch, e.g. `master`, and merge back against that branch.
20
+
- Checkout a topic branch from a base branch, e.g. `main`, and merge back against that branch.
21
+
22
+
-[Make sure to tick the "Allow edits from maintainers" box](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). This allows us to directly make minor edits / refactors and saves a lot of time.
21
23
22
24
- If adding a new feature:
23
25
@@ -40,7 +42,7 @@ Hi! I'm really excited that you are interested in contributing to Vue.js. Before
40
42
41
43
## Development Setup
42
44
43
-
You will need [Node.js](https://nodejs.org)**version 10+**, and [PNPM](https://pnpm.io).
45
+
You will need [Node.js](https://nodejs.org)**version 16+**, and [PNPM](https://pnpm.io)**version 7+**.
44
46
45
47
We also recommend installing [ni](https://github.com/antfu/ni) to help switching between repos using different package managers. `ni` also provides the handy `nr` command which running npm scripts easier.
46
48
@@ -90,7 +92,7 @@ Additional formats that only apply to the main `vue` package:
90
92
-**`esm-bundler-runtime`**
91
93
-**`esm-browser-runtime`**
92
94
93
-
More details about each of these formats can be found in the [`vue` package README](https://github.com/vuejs/vue-next/blob/master/packages/vue/README.md#which-dist-file-to-use) and the [Rollup config file](https://github.com/vuejs/vue-next/blob/master/rollup.config.js).
95
+
More details about each of these formats can be found in the [`vue` package README](https://github.com/vuejs/core/blob/main/packages/vue/README.md#which-dist-file-to-use) and the [Rollup config file](https://github.com/vuejs/core/blob/main/rollup.config.js).
94
96
95
97
For example, to build `runtime-core` with the global build only:
96
98
@@ -123,19 +125,22 @@ The `dev` script bundles a target package (default: `vue`) in a specified format
- The `dev` script also supports fuzzy match for the target package, but will only match the first package matched.
131
+
-**Important:** output of the `dev` script is for development and debugging only. While it has the same runtime behavior, the generated code should never be published to npm.
132
+
133
+
- The `dev` script does not support fuzzy match - you must specify the full package name, e.g. `nr dev runtime-core`.
131
134
132
135
- The `dev` script supports specifying build format via the `-f` flag just like the `build` script.
133
136
134
137
- The `dev` script also supports the `-s` flag for generating source maps, but it will make rebuilds slower.
135
138
139
+
- The `dev` script supports the `-i` flag for inlining all deps. This is useful when debugging `esm-bundler` builds which externalizes deps by default.
140
+
136
141
### `nr dev-compiler`
137
142
138
-
The `dev-compiler` script builds, watches and serves the [Template Explorer](https://github.com/vuejs/vue-next/tree/master/packages/template-explorer) at `http://localhost:5000`. This is extremely useful when working on the compiler.
143
+
The `dev-compiler` script builds, watches and serves the [Template Explorer](https://github.com/vuejs/core/tree/main/packages/template-explorer) at `http://localhost:5000`. This is extremely useful when working on the compiler.
139
144
140
145
### `nr test`
141
146
@@ -175,6 +180,8 @@ This repository employs a [monorepo](https://en.wikipedia.org/wiki/Monorepo) set
175
180
176
181
-`compiler-dom`: Compiler with additional plugins specifically targeting the browser.
177
182
183
+
-`compiler-sfc`: Lower level utilities for compiling Vue Single File Components.
184
+
178
185
-`compiler-ssr`: Compiler that produces render functions optimized for server-side rendering.
179
186
180
187
-`template-explorer`: A development tool for debugging compiler output. You can run `nr dev template-explorer` and open its `index.html` to get a repl of template compilation based on current source code.
0 commit comments