Skip to content

Commit a7cb9f6

Browse files
authored
docs: add contributor windows os non-homedrive usage (#606)
1 parent c118911 commit a7cb9f6

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
If you want to build Corepack yourself, you can build the project like this:
44

5-
1. Clone this repository.
5+
1. Clone this repository. Some restrictions on the cloning location apply to Windows users, read [Contributing on Windows](#contributing-on-windows) for more information.
66
2. Run `yarn install` (or `corepack yarn install` if the global version of
77
`yarn` is not provided by Corepack).
88
3. Run `yarn build` (or `corepack yarn build`).
@@ -11,6 +11,12 @@ The `dist/` directory now contains the corepack build and the shims.
1111
Call `node ./dist/corepack --help` and behold.
1212
You can also run the tests with `yarn test`.
1313

14+
## Contributing on Windows
15+
16+
If you are cloning the repo to a directory on a Microsoft Windows operating system, it is recommended to use the same drive as your Windows `HOMEDRIVE` to avoid build and other issues related to a current restriction with Yarn Plug'n'Play caching.
17+
18+
If you are unable to use your `HOMEDRIVE`, you may be able to work around the issue by setting the environment variable `YARN_ENABLE_GLOBAL_CACHE` to `false` before running `yarn install` (or `corepack yarn install`).
19+
1420
# Adding a new package manager
1521

1622
New package managers can be added by editing the following files:

0 commit comments

Comments
 (0)