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.

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

doc: add policy for “placeholder” executables #52107

Closed
Closed
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions doc/contributing/distribution.md
Expand Up @@ -25,3 +25,18 @@ only as a semver-major change, unless the related feature or project is
documented as experimental. In addition, Node.js includes external projects as
internal dependencies. These may be replaced or removed at any time, provided
that doing so is not a breaking change.

## Placeholder executables

Installing Node.js will not create "placeholder" executables for package
managers. A placeholder executable is a binary, symlink or script that has a
name that refers to software that is not distributed with Node.js, but instead
would be downloaded when the executable is run. For example, Node.js will not
create `yarn` or `download_yarn` placeholder executables that will download Yarn
when run. Node.js includes `npm` and `npx` executables, but these are not
placeholders because the name of the executable refers to software that is
contained within the Node.js distribution.

Adding placeholder executables that refer to other types of software besides
package managers will first require an affirmative vote of the Node.js Technical
Steering Committee.
GeoffreyBooth marked this conversation as resolved.
Show resolved Hide resolved