The Pull Request System in GitHub - bounswe/bounswe2017group3 GitHub Wiki
About
Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before the changes are merged into the repository.
Pull requests are commonly used by teams and organizations collaborating using the Shared Repository Model (which we use here on GitHub), where everyone shares a single repository and topic branches are used to develop features and isolate changes.
After initializing a pull request, you'll see a review page that shows a high-level overview of the changes between your branch (the compare branch) and the repository's base branch. You can add a summary of the proposed changes, review the changes made by commits, add labels, milestones, and assignees, and @mention individual contributors or teams. For more information, take a look at "Creating a pull request."
An example pull request review page:
Once you've created a pull request, you can push commits from your topic branch to add them to your existing pull request. These commits will appear in chronological order within your pull request and the changes will be visible in the "Files changed" tab.
Other contributors can review your proposed changes, add review comments, contribute to the pull request discussion, and even add commits to the pull request.
After you're happy with the proposed changes, you can merge the pull request. If you're working in a shared repository model, the proposed changes will be merged from the head branch to the base branch that was specified in the pull request.
Creating a Pull Request
It's very simple. Let me list you down the steps:
- First create a new branch:
git checkout -b <branch-name>
- Make your changes and don't forget to commit them in small chunks.
- Push your branch to the repository:
git push origin <branch-name>
- Go to the repository page on GitHub. Which is https://github.com/bounswe/bounswe2017group3/ in our case.
- You should see a yellow highlighted text, where there should be a button on the right to create your pull request. Click to that button.
- If there is no yellow highlighted text, click to the
New pull request
button on top-left.
- If there is no yellow highlighted text, click to the
- Pick your branch using the
compare:
dropdown. If you've come to the pull request create page from the yellow highlighted text, it should come as selected automatically. - Enter an appropriate title and description for your pull request, then click to the green
Send pull request
button.