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
Copy file name to clipboardExpand all lines: .github/contributing.md
+11-9
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,11 @@ 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. `main`, and merge back against that branch.
20
+
- Vue core has two primary work branches: `main` and `minor`.
21
+
22
+
- If your pull request is a feature that adds new API surface, it should be submitted against the `minor` branch.
23
+
24
+
- Otherwise, it should be submitted against the `main` branch.
21
25
22
26
-[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.
23
27
@@ -57,7 +61,7 @@ Hi! I'm really excited that you are interested in contributing to Vue.js. Before
57
61
58
62
## Development Setup
59
63
60
-
You will need [Node.js](https://nodejs.org)**version 16+**, and [PNPM](https://pnpm.io)**version 7+**.
64
+
You will need [Node.js](https://nodejs.org)**version 18.12+**, and [PNPM](https://pnpm.io)**version 8+**.
61
65
62
66
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.
63
67
@@ -181,11 +185,11 @@ Shortcut for starting the SFC Playground in local dev mode. This provides the fa
181
185
182
186
### `nr dev-esm`
183
187
184
-
Builds and watches `vue/dist/vue-runtime.esm-bundler.js` with all deps inlined using esbuild. This is useful when debugging the ESM build in a reproductions that require real build setups: link `packages/vue` globally, then link it into the project being debugged.
188
+
Builds and watches `vue/dist/vue-runtime.esm-bundler.js` with all deps inlined using esbuild. This is useful when debugging the ESM build in a reproduction that requires real build setups: link `packages/vue` globally, then link it into the project being debugged.
185
189
186
190
### `nr dev-compiler`
187
191
188
-
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 useful when working on pure compiler issues.
192
+
The `dev-compiler` script builds, watches and serves the [Template Explorer](https://github.com/vuejs/core/tree/main/packages/template-explorer) at `http://localhost:3000`. This is useful when working on pure compiler issues.
189
193
190
194
### `nr test`
191
195
@@ -244,12 +248,10 @@ This repository employs a [monorepo](https://en.wikipedia.org/wiki/Monorepo) set
244
248
245
249
-`dts-test`: Contains type-only tests against generated dts files.
246
250
247
-
-`sfc-playground`: The playground continuously deployed at https://sfc.vuejs.org. To run the playground locally, use [`nr dev-sfc`](#nr-dev-sfc).
251
+
-`sfc-playground`: The playground continuously deployed at https://play.vuejs.org. To run the playground locally, use [`nr dev-sfc`](#nr-dev-sfc).
248
252
249
253
-`template-explorer`: A development tool for debugging compiler output, continuously deployed at https://template-explorer.vuejs.org/. To run it locally, run [`nr dev-compiler`](#nr-dev-compiler).
250
254
251
-
-`size-check`: Used for checking built bundle sizes on CI.
252
-
253
255
### Importing Packages
254
256
255
257
The packages can import each other directly using their package names. Note that when importing a package, the name listed in its `package.json` should be used. Most of the time the `@vue/` prefix is needed:
@@ -261,7 +263,7 @@ import { h } from '@vue/runtime-core'
261
263
This is made possible via several configurations:
262
264
263
265
- For TypeScript, `compilerOptions.paths` in `tsconfig.json`
264
-
- Vitest and Rollup share the sae set of aliases from `scripts/aliases.js`
266
+
- Vitest and Rollup share the same set of aliases from `scripts/aliases.js`
265
267
- For plain Node.js, they are linked using [PNPM Workspaces](https://pnpm.io/workspaces).
266
268
267
269
### Package Dependencies
@@ -330,4 +332,4 @@ Funds donated via Patreon go directly to support Evan You's full-time work on Vu
330
332
331
333
Thank you to all the people who have already contributed to Vue.js!
0 commit comments