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

Jump to bottom

Adds a note clarifying how to add new package managers #408

Merged
merged 3 commits into from
Feb 27, 2024
Merged

Adds a note clarifying how to add new package managers #408

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b079203
Adds a note explicitating how to add new package managers
arcanis Feb 27, 2024
9213bde
Update CONTRIBUTING.md
arcanis Feb 27, 2024
8b8f877
Update CONTRIBUTING.md
arcanis Feb 27, 2024
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: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ 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`.

# Adding a new package manager

New package managers can be added by editing the [config.json](/config.json) file.
arcanis marked this conversation as resolved.
Show resolved Hide resolved

Once added, the shims pertaining to new package managers won't be automatically enabled by `corepack enable` when called without arguments - it'll require users to explicitly install the relevant shims (e.g. `corepack enable mypm`). A separate PR adding the package manager to the default list can be opened a couple of months after the new package manager was introduced.

Finally, for the package manager to be distributed by default with Node.js, a separate PR will have to be made against the [nodejs/node](https://github.com/nodejs/node) repository asking for standard inclusion, following the process outlined in [GOVERNANCE.md](https://github.com/nodejs/node/blob/main/GOVERNANCE.md).
arcanis marked this conversation as resolved.
Show resolved Hide resolved

## Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:
Expand Down