Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

26 lines (16 loc) · 1.98 KB
Raw

Contributing to docker-node

Thank you for your contribution. Here are a set of guidelines for contributing to the docker-node project.

Version Updates

New Node.js releases are released as soon as possible.

New NPM releases are not tracked. We simply use the NPM version bundled in the corresponding Node.js release.

Yarn is updated to the latest version only when there is a new Node.js SemVer PATCH release (unless Yarn has received a security update), and it's updated only in the branch with the new release, preferably in the same PR. The update.sh script does this automatically when invoked with a specific branch, e.g. ./update.sh 6.10.

Submitting a PR for a version update

If you'd like to help us by submitting a PR for a version update, please do the following:

  1. Fork this project.
  2. Clone the forked repository.
  3. Create a branch for the update PR. For example, git checkout main; git checkout -b version-update.
  4. Run ./update.sh. You can see additional options by using accessing the built-in help documentation with ./update.sh -h. This script will automatically update the appropriate files with the latest versions and checksums.
  5. Commit the modified files to the version-update branch and push the branch to your fork.
  6. Create a PR to merge the branch from your fork into this project's default branch..

Adding dependencies to the base images

NodeJS is a big ecosystem with a variety of different use cases. The docker images for node are designed to provide the minimum for running core node. Additional dependencies (including dependencies for npm or yarn such as git) will not be included in these base images and will need to be included in descendent image.