- If you don't already have one, create a GitHub account.
- Open the Node.js core repository web page.
- Use the "Fork" button to fork the repository:
- On the page for your own fork, use the "Clone or download" button and copy the URL for cloning to your clipboard:
- On the command line, in your home directory or a directory you have for projects, run:
git clone <paste that URL here!>
- When that is done:
git remote add upstream https://github.com/nodejs/node.git
- Optional, but recommended: Configure `git` so that it knows who
git config --global user.name "<Your Name Here!>"
Make sure your email address is also added to your
GitHub email list
so that your commits will be properly associated with your account
and you will be promoted to Contributor once your first commit is
git config --global user.email "<Your Email Address Here!>"
- Follow the instructions to build Node.js. You should not install the version of Node.js built with these instructions. Follow the instructions to build and test only. Once you have `make test` or `vcbuild test` running successfully, you can stop and come back here.
- If you have not already done so, set git to use the name and email address you would like your commits to be credited to.
git config --global user.name "J. Q. User"
git config --global user.email "firstname.lastname@example.org"
- Email email@example.com to get a good first issue to work on or to get help with any of the above steps.
- After you have your first pull request open, you can look at the Next Steps page for suggestions on ways to find additional issues to work on.