Your First Pull Request

Introduction

Creating and managing a pull request to its completion is the last step to getting a contribution into the master repository where everyone can play it!

Before you create a pull request, make sure you have followed the style and tree hygiene guidelines, and that you have adequately tested the commits so no unexpected errors occur. Make sure to thoroughly test the features you create and add safety features that help prevent possible abuse are critical steps to passing the pull request process.

Preparing a pull request

Once everything is sorted and up to standards, it is time to create the pull request and send it in for approval. You must have created an independent branch with every commit regarding the feature you are planning to add.

The first step is to push the local branch to the remote. You should fork the repository into one of your own and push your local branch to this repository. To do so, follow the steps listed below:

1. Visit the main project page and click on the "fork" button on the top right of the screen.
2. Add your newly created repository as a remote via git (either directly or through a git extension on a third-party program).
3. Push your branch to this repository and give it a name that describes, at a glance, the feature you are adding.

Sending a pull request for approval

With the fully developed branch now in an available repository, head back to the main project site and follow these steps:

1. Click on the "pull requests" tab.
2. Click on the "new pull request" button.
3. Select the "compare across forks" option above the branch selection menu.
4. Set the "base" of your pull request to the default master branch in the live repository, and under the "compare" field, select the feature branch in your forked repository.
5. When everything is correctly set up and the shown commits match what you expect, click the "Create pull request" option.
6. Give your pull request a meaningful but concise title, and explain the nature of the feature you created in the description, what niche it fills, and overall why you made it and what there is to watch out for; if anything.
7. Submit your pull request and wait for approval. At least one of the project managers will leave a "LGTM" (Looks Good To Me) comment to let you know of their approval.

After this process is over, your project branch will be merged into the master branch! You may then delete the branch you created in your remote and even the entire forked repository as a whole. You should then work from the updated master branch as usual.