Skip to content

doc: add policy for executables #51994

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

Closed
wants to merge 7 commits into from
Closed

doc: add policy for executables #51994

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7cc22e4
doc: add policy for executables
GeoffreyBooth Mar 6, 2024
ca2fa32
reword
GeoffreyBooth Mar 7, 2024
bff9dbc
reword
GeoffreyBooth Mar 7, 2024
f939d26
reword
GeoffreyBooth Mar 7, 2024
54699e0
exclude executables that aren't provided for direct execution
GeoffreyBooth Mar 7, 2024
876390f
shorten
GeoffreyBooth Mar 12, 2024
18f397d
add example
GeoffreyBooth Mar 13, 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
13 changes: 13 additions & 0 deletions doc/contributing/distribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,16 @@ 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.

## Executables

The Node.js distribution adds a number of executable commands into the user's
`PATH`, such as `node`. The distribution will only include executables that run
code that is vendored within the Node.js distribution. The distribution will not
include executables to run code that is downloaded after installation.

For example, the distribution includes an `npm` executable to run the npm
package manager, which can be used to download other software, some of which may
create their own executables. The Node.js distribution will not include a `foo`
executable that would either directly download the full `foo` software or use
`npm` or Corepack to download `foo`.