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-7Lines changed: 11 additions & 7 deletions
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,9 +61,9 @@ 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 8+**.
64
+
You will need [Node.js](https://nodejs.org)**version 18.12+**, and [PNPM](https://pnpm.io)**version 8+**.
61
65
62
-
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.
66
+
We also recommend installing [@antfu/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
64
68
After cloning the repo, run:
65
69
@@ -82,11 +86,11 @@ The project uses [simple-git-hooks](https://github.com/toplenboren/simple-git-ho
82
86
83
87
- Type check the entire project
84
88
- Automatically format changed files using Prettier
85
-
- Verify commit message format (logic in `scripts/verifyCommit.js`)
89
+
- Verify commit message format (logic in `scripts/verify-commit.js`)
86
90
87
91
## Scripts
88
92
89
-
**The examples below will be using the `nr` command from the [ni](https://github.com/antfu/ni) package.** You can also use plain `npm run`, but you will need to pass all additional arguments after the command after an extra `--`. For example, `nr build runtime --all` is equivalent to `npm run build -- runtime --all`.
93
+
**The examples below will be using the `nr` command from the [@antfu/ni](https://github.com/antfu/ni) package.** You can also use plain `npm run`, but you will need to pass all additional arguments after the command after an extra `--`. For example, `nr build runtime --all` is equivalent to `npm run build -- runtime --all`.
90
94
91
95
The `run-s` and `run-p` commands found in some scripts are from [npm-run-all](https://github.com/mysticatea/npm-run-all) for orchestrating multiple scripts. `run-s` means "run in sequence" while `run-p` means "run in parallel".
92
96
@@ -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.
0 commit comments