Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add contributor windows os non-homedrive usage #606

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add contributor windows os non-homedrive usage #606

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a29af36
docs: add contributor windows os non-homedrive usage
MikeMcC399 Jan 21, 2025
44bfa16
reword reference to Windows section
MikeMcC399 Jan 28, 2025
57da0f5
Merge branch 'main' into docs/windows-drive
MikeMcC399 Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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

## Contributing on Windows

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.

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`).

# Adding a new package manager

New package managers can be added by editing the following files:
Expand Down
Loading