OPTIONS

Github 101: Set Up a Fork

MongoDB projects are available on GitHub. For a list of the MongoDB supported projects on GitHub, see Choose a Project.

If you are not familiar with the git version control system, see http://git-scm.com/book/en/Getting-Started

To contribute to a MongoDB project, you should create a fork of the project repository or repo. To fork a repository and set up a branch to work on:

1

Fork the repository.

Go to the url of the repository you want to fork and fork the repo.

Fork your own copy of the repo by clicking the Fork link.
2

Grab the clone url.

Go to your fork and grab the clone url.

images/github-clone-url.png
3

Clone your fork to your local machine.

On your local machine, issue the following command, using the clone url from the previous step:

git clone <clone url>
4

Create and checkout a new branch.

Create a branch on your local machine. It is good practice to name the branch after the ticket you are working on; for example python-555 or server-11321.

git checkout -b <branch name>

Now that you’re set up with git, it’s time to begin making your changes.

More Git Resources

For a tutorial on forking a repo, see https://help.github.com/articles/fork-a-repo.

For a tutorial on branches, see https://help.github.com/articles/creating-and-deleting-branches-within-your-repository.