Pull Requests
=============

Creating Pull Requests
----------------------

Once your changes are ready to be submitted to the xcat team, the easiest way to generate a pull request is from the GitHub UI. 

#. Under your project, click on the "branches" link

   .. image:: github-pullrequest_branch.png

#. Find the branch that contains your changes and click on the "New pull request" button

   .. image:: github-create_pullrequest.png

#. Submit the pull request!

Changing Pull Request
---------------------

After submitting a pull request, you may get comments from reviewer that something needs to be changed. Then you can use following steps to change your pull request.

#. Change any code and add them to be tracked in git ::

    $ git checkout <mybranch>
    $ vi <files>
    $ git add <files>

#. Commit the change to last commit in the branch instead of creating a new commit. This step is useful to keep the change of this pull request in one commit instead of multiple ones. ::

    $ git commit --amend

#. Push the new commit to remote repository. Then the commit will be displayed in pull request automatically. ::

    $ git push origin <mybranch> -f

Resolving Conflict in the Pull Request
--------------------------------------

During the reviewing of your pull request, another pull request may be merged which contains changes that conflict with your change so that your pull request can no longer be merged automatically.  You can use following steps to resolve the conflict.

#. Update the upstream, replace <upstream> with the name if your upstream repo ::

    $ git fetch <upstream>

#. Checkout to your working branch ::

    $ git checkout <mybranch>

#. rebase your branch to the master branch in the <upstream> ::

    $ git rebase <upstream>/master

#. In the previous step, you will see some CONFLICT when merging certain files.  Edit the files to resolve the conflicts manually and then **add** the files to be tracked in git. ::

    $ vi  <files>
    $ git add <files>

#. Continue the rebase and repeate the above step for any additional CONFLITs ::

    $ git rebase --continue

#. Once the rebase is complete and CONFLICTs resolved, **force** push the change to your repository ::

    $ git push origin <mybranch> -f

If the CONFLICTs are resolved, the pull request should automaically turn green and able to be merged automatically. 

Reviewing Pull Requests as a Maintainer
---------------------------------------

When you are looking over a pull request, you can merge the changes into your own temporary branch to give the code or changes a try before merging into the parent project. 

#. From the merge request, click on the ``command line instructions`` link: 

   .. image:: github-merge_command_line.png

#. Then under **Step 1:**, there are instruction for creating a temp branch and pulling the changes from the pull request: 

   .. image:: github-merge_step1.png