From d97150d566a7032478d4c0f624f5c9d1363501d1 Mon Sep 17 00:00:00 2001 From: Yang Su Date: Fri, 29 Mar 2013 04:08:21 -0400 Subject: [PATCH] started the creating a pull request section Creating a pull request Creating a pull request: head branch dropdown Creating a pull request: title and description and send pull request Creating a pull request: open pull request screen shot Using a pull request: comments, commits, diff, and in line comments Merging a pull request: merge pull request button Merging a pull request: merging locally Merging a pull request: rebase discussion Merging a pull request: rebase commands Merging a pull request: squashing commits Merging a pull request: force push Updated screen shots Corrected solution to need a single revision error --- Readme.md | 98 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) diff --git a/Readme.md b/Readme.md index dc27523..1a5be41 100644 --- a/Readme.md +++ b/Readme.md @@ -34,3 +34,101 @@ git checkout -b pull-request-demo git push origin pull-request-demo ``` +### Creating a Pull Request + +To create a pull request, you must have changes committed to the your new branch. + +Go to the repository page on github. And click on "Pull Request" button in the repo header. + +![Pull Request Button](https://f.cloud.github.com/assets/676185/316845/2ea7d418-9848-11e2-90af-5b8f31497a51.png) + +Pick the branch you wish to have merged using the "Head branch" dropdown. You should leave the rest of the fields as is, unless you are working from a remote branch. In that case, please refer to the [remote branch pull request guide](). + +![Head Branch Dropdown](https://f.cloud.github.com/assets/676185/316857/0d51b008-9849-11e2-909a-36e6f12436b4.png) + +Enter a **title** and **description** for your pull request. Remember you can use [Github Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) in the description and comments + +![Title and Description](https://f.cloud.github.com/assets/676185/316873/0c0e4cc8-984a-11e2-89f5-703c31217e17.png) + +Finally, click on the green "Send pull request" button to finish creating the pull request. + +![Send Pull Request](https://f.cloud.github.com/assets/676185/316876/30d6d0ca-984a-11e2-9c5e-420223c35ed9.png) + +You should now see an open pull request. + +![Open Pull Request](https://f.cloud.github.com/assets/676185/316899/6a62a7c8-984b-11e2-92ee-182ef257b574.png) + +### Using a Pull Request + +You can write comments related to a pull request, + +![Writing a comment](https://f.cloud.github.com/assets/676185/316903/d9729df8-984b-11e2-9bf6-8fe064957723.png) + +view all the commits by all contained by a pull request under the commits tab, + +![Commits tab](https://f.cloud.github.com/assets/676185/316908/563073ba-984c-11e2-8bd6-450939fbd7b3.png) + +or see all the file changes from the pull request across all the commits under the "Files Changed" tab. + +![Files Changed](https://f.cloud.github.com/assets/676185/316911/9e4cbe42-984c-11e2-9636-dd50cb98db44.png) + +You can event leave a comment on particular lines in the code change simply by hovering to the left of a line and clicking on the blue note icon. + +![Comment in line](https://f.cloud.github.com/assets/676185/316916/015be558-984d-11e2-9c4c-2ddc793fac3c.png) + +### Merging a Pull Request + +Once you and your collaborators are happy with the changes, you start to merge the changes back to master. There are a few ways to do this. + +First, you can use github's "Merge pull request" button at the bottom of your pull request to merge your changes. This is only available when github can detect that there will be no merge conflicts with the base branch. If all goes well, you just have to add a commit message and click on "Confirm Merge" to merge the changes. + +![Merge pull request button](https://f.cloud.github.com/assets/676185/316946/e8c42c4c-984e-11e2-8a09-5a977652028a.png) +![Confirm Merge](https://f.cloud.github.com/assets/676185/316947/ea15ebee-984e-11e2-8c08-e76a54c89755.png) + +#### Merging Locally + +If the pull request cannot be merged online due to merge conflicts, or you wish to test things locally before sending the merge to the repo on Github, you can perform the merge locally instead. + +You can find the instruction to do so by clicking the `(i)` icon on the merge bar. + +![Merging Instructions](https://f.cloud.github.com/assets/676185/316954/b34855f6-984f-11e2-9713-6c8288617a78.png) + +However, there's an alternative that's better in my opinion, particularly for long standing branches. + +#### Squash, Rebase, and Cherry Pick + +In long standing branches, merging can often cause lots problems when updating if changes in a given branch conflict with changes recently merged into the master branch. If there are many commits to the same file, `git merge` may force you to fix the same merge conflicts over and over again, causing a real headache. While there are many ways to mitigate this issue, such as enabling [`git rerere`](https://www.kernel.org/pub/software/scm/git/docs/git-rerere.html) to reuse recorded resolution of conflict merges, squashing a series of related changes into 1 commit and cherry-picking it into the master is a great solution, especially for topic branches and isolated features. + +There are several advantages of performing merges this way. First, you only have to deal with merge conflicts once, since all commits are compressed into 1. Second, each commit represents an entire set of changes required for a feature or task, which makes it easy to pin point bugs and other problems when they arise and to remove a change set when it's no longer necessary. + +There are also disadvantages of squashing commits. First, you will lose the details and information for each change, as all changes squashed are compressed together. So the net effect is the same. Second, it can be dangerous and problematic if used incorrectly, such as squashing commits that have been pushed to the remote server **and** others depend on for their work. Because squashing is changing the git history, you can cause many conflicts that way. However, if you are using this locally or you are the only person working on your branch and you know exactly what you are doing. + +To perform this, use the following command + +```bash +git rebase -i HEAD~10 +``` + +`-i` stands for [interactive mode](http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) and `HEAD~10` means to examine the 10 latest commits. + +If you see an `fatal: Needed a single revision` error, this usually means that there are not that many commits left. Try a lower number. + +This will open up an editor with git commit messages that looks something like this: + +![Git Rebase](https://f.cloud.github.com/assets/676185/317107/cdcd54d6-9858-11e2-9e78-7642fa363f10.png) + +There are many options available at this stage. These are detailed in [this github help page](https://help.github.com/articles/interactive-rebase). Here, I'm going to simply squash all changes in this pull request into one. Save and close the editor. + +![Squashing commits](https://f.cloud.github.com/assets/676185/317112/21e1a702-9859-11e2-8c03-7f344002768e.png) + +The next screen will pop up asking you to edit your commit messages. You can choose to edit them or simply continue. Save and close the editor. + +![Squash Result](https://f.cloud.github.com/assets/676185/317086/cb3933f8-9857-11e2-9909-44cdd256bc11.png) + +Once your squash completes, you can push it to the remote repo. In this case, these squashed commits have been pushed to the server. However, I'm the only user of this branch and can safely force push the commit to update the git repo. + +```bash +git push origin pull-request-demo -f +``` + +The pull request will automatically update to reflect the changes. \ No newline at end of file