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
+10-10
Original file line number
Diff line number
Diff line change
@@ -6,30 +6,30 @@ Please read our [Code of Conduct](CODE_OF_CONDUCT.md) and follow it in all your
6
6
7
7
## Local development
8
8
9
-
This project is configured in a monorepo, where one repository contains multiple npm packages. Dependencies are installed and managed with `yarn`, not `npm` CLI.
9
+
This project is configured in a monorepo, where one repository contains multiple npm packages. Dependencies are installed and managed with `pnpm`, not `npm` CLI.
10
10
11
11
To get started, execute the following:
12
12
13
13
```
14
14
git clone https://github.com/vercel/vercel
15
15
cd vercel
16
16
corepack enable
17
-
yarn install
18
-
yarn bootstrap
19
-
yarn build
20
-
yarn lint
21
-
yarn test-unit
17
+
pnpm install
18
+
pnpm bootstrap
19
+
pnpm build
20
+
pnpm lint
21
+
pnpm test-unit
22
22
```
23
23
24
24
Make sure all the tests pass before making changes.
25
25
26
26
### Running Vercel CLI Changes
27
27
28
-
You can use `yarn dev` from the `cli` package to invoke Vercel CLI with local changes:
28
+
You can use `pnpm dev` from the `cli` package to invoke Vercel CLI with local changes:
29
29
30
30
```
31
31
cd ./packages/cli
32
-
yarn dev <cli-commands...>
32
+
pnpm dev <cli-commands...>
33
33
```
34
34
35
35
See [CLI Local Development](../packages/cli#local-development) for more details.
@@ -39,7 +39,7 @@ See [CLI Local Development](../packages/cli#local-development) for more details.
39
39
Once you are done with your changes (we even suggest doing it along the way), make sure all the tests still pass by running:
40
40
41
41
```
42
-
yarn test-unit
42
+
pnpm test-unit
43
43
```
44
44
45
45
from the root of the project.
@@ -102,7 +102,7 @@ When you run this script, you'll see all the imported files. If anything file is
102
102
Sometimes you want to test changes to a Builder against an existing project, maybe with `vercel dev` or actual deployment. You can avoid publishing every Builder change to npm by uploading the Builder as a tarball.
103
103
104
104
1. Change directory to the desired Builder `cd ./packages/node`
105
-
2. Run `yarn build` to compile typescript and other build steps
105
+
2. Run `pnpm build` to compile typescript and other build steps
106
106
3. Run `npm pack` to create a tarball file
107
107
4. Run `vercel *.tgz` to upload the tarball file and get a URL
108
108
5. Edit any existing `vercel.json` project and replace `use` with the URL
Copy file name to clipboardexpand all lines: README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -33,9 +33,9 @@ For details on how to use Vercel, check out our [documentation](https://vercel.c
33
33
34
34
## Contributing
35
35
36
-
This project uses [yarn](https://yarnpkg.com/) to install dependencies and run scripts.
36
+
This project uses [pnpm](https://pnpm.io/) to install dependencies and run scripts.
37
37
38
-
You can use the `dev` script to run local changes as if you were invoking Vercel CLI. For example, `vercel deploy --cwd=/path/to/project` could be run with local changes with `yarn dev deploy --cwd=/path/to/project`.
38
+
You can use the `dev` script to run local changes as if you were invoking Vercel CLI. For example, `vercel deploy --cwd=/path/to/project` could be run with local changes with `pnpm dev deploy --cwd=/path/to/project`.
39
39
40
40
See the [Contributing Guidelines](./.github/CONTRIBUTING.md) for more details.
0 commit comments