Merge pull request nodejs#1193 from clayzermk1/version-update-instructions

LaurentGoderre · web-flow · commit 8bcc1712f430 · 2020-01-13T16:14:55.000-05:00
Add instructions for submitting a version update PR
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -10,6 +10,17 @@ New **NPM** releases are not tracked. We simply use the NPM version bundled in t
 
 **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.](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
+1. [Clone the forked repository.](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
+1. Create a branch for the update PR. For example, `git checkout master; git checkout -b version-update`.
+1. 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.
+1. Commit the modified files to the `version-update` branch and push the branch to your fork.
+1. [Create a PR to merge the branch from your fork into this project's master branch.](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
+
 ## 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.
