Signed-off-by: Raghuram Devarakonda <draghuram@gmail.com>
| ... | ... |
@@ -89,7 +89,7 @@ The following provides greater detail on the process: |
| 89 | 89 |
This is a Markdown file that describes your idea. Your proposal |
| 90 | 90 |
should include information like: |
| 91 | 91 |
|
| 92 |
- * Why is this changed needed or what are the use cases? |
|
| 92 |
+ * Why is this change needed or what are the use cases? |
|
| 93 | 93 |
* What are the requirements this change should meet? |
| 94 | 94 |
* What are some ways to design/implement this feature? |
| 95 | 95 |
* Which design/implementation do you think is best and why? |
| ... | ... |
@@ -6,8 +6,8 @@ page_keywords: change, commit, squash, request, pull request, test, unit test, i |
| 6 | 6 |
|
| 7 | 7 |
This checklist summarizes the material you experienced working through [make a |
| 8 | 8 |
code contribution](/project/make-a-contribution) and [advanced |
| 9 |
-contributing](/project/advanced-contributing). The checklist applies to code |
|
| 10 |
-that is program code or code that is documentation code. |
|
| 9 |
+contributing](/project/advanced-contributing). The checklist applies to both |
|
| 10 |
+program code and documentation code. |
|
| 11 | 11 |
|
| 12 | 12 |
## Change and commit code |
| 13 | 13 |
|
| ... | ... |
@@ -22,7 +22,7 @@ Before you create a pull request, check your work. |
| 22 | 22 |
2. Checkout your feature branch. |
| 23 | 23 |
|
| 24 | 24 |
$ git checkout 11038-fix-rhel-link |
| 25 |
- Already on '11038-fix-rhel-link' |
|
| 25 |
+ Switched to branch '11038-fix-rhel-link' |
|
| 26 | 26 |
|
| 27 | 27 |
3. Run the full test suite on your branch. |
| 28 | 28 |
|
| ... | ... |
@@ -41,7 +41,11 @@ Before you create a pull request, check your work. |
| 41 | 41 |
|
| 42 | 42 |
Always rebase and squash your commits before making a pull request. |
| 43 | 43 |
|
| 44 |
-1. Fetch any of the last minute changes from `docker/docker`. |
|
| 44 |
+1. Checkout your feature branch in your local `docker-fork` repository. |
|
| 45 |
+ |
|
| 46 |
+ This is the branch associated with your request. |
|
| 47 |
+ |
|
| 48 |
+2. Fetch any last minute changes from `docker/docker`. |
|
| 45 | 49 |
|
| 46 | 50 |
$ git fetch upstream master |
| 47 | 51 |
From github.com:docker/docker |
| ... | ... |
@@ -56,28 +60,28 @@ Always rebase and squash your commits before making a pull request. |
| 56 | 56 |
pick 1a79f55 Tweak some of the other text for grammar |
| 57 | 57 |
pick 53e4983 Fix a link |
| 58 | 58 |
pick 3ce07bb Add a new line about RHEL |
| 59 |
- |
|
| 60 |
- If you run into trouble, `git --rebase abort` removes any changes and gets |
|
| 61 |
- you back to where you started. |
|
| 62 | 59 |
|
| 63 |
-4. Squash the `pick` keyword with `squash` on all but the first commit. |
|
| 60 |
+5. Replace the `pick` keyword with `squash` on all but the first commit. |
|
| 64 | 61 |
|
| 65 | 62 |
pick 1a79f55 Tweak some of the other text for grammar |
| 66 | 63 |
squash 53e4983 Fix a link |
| 67 | 64 |
squash 3ce07bb Add a new line about RHEL |
| 68 | 65 |
|
| 69 |
- After closing the file, `git` opens your editor again to edit the commit |
|
| 70 |
- message. |
|
| 66 |
+ After you save the changes and quit from the editor, git starts |
|
| 67 |
+ the rebase, reporting the progress along the way. Sometimes |
|
| 68 |
+ your changes can conflict with the work of others. If git |
|
| 69 |
+ encounters a conflict, it stops the rebase, and prints guidance |
|
| 70 |
+ for how to correct the conflict. |
|
| 71 | 71 |
|
| 72 |
-5. Edit and save your commit message. |
|
| 72 |
+6. Edit and save your commit message. |
|
| 73 | 73 |
|
| 74 | 74 |
`git commit -s` |
| 75 | 75 |
|
| 76 | 76 |
Make sure your message includes <a href="./set-up-git" target="_blank>your signature</a>. |
| 77 | 77 |
|
| 78 |
-8. Push any changes to your fork on GitHub. |
|
| 78 |
+7. Force push any changes to your fork on GitHub. |
|
| 79 | 79 |
|
| 80 |
- $ git push origin 11038-fix-rhel-link |
|
| 80 |
+ $ git push -f origin 11038-fix-rhel-link |
|
| 81 | 81 |
|
| 82 | 82 |
## Create a PR on GitHub |
| 83 | 83 |
|
| ... | ... |
@@ -108,7 +112,7 @@ You create and manage PRs on GitHub: |
| 108 | 108 |
4. Scroll down and verify the PR contains the commits and changes you expect. |
| 109 | 109 |
|
| 110 | 110 |
For example, is the file count correct? Are the changes in the files what |
| 111 |
- you expect. |
|
| 111 |
+ you expect? |
|
| 112 | 112 |
|
| 113 | 113 |
 |
| 114 | 114 |
|
| ... | ... |
@@ -124,4 +128,4 @@ You create and manage PRs on GitHub: |
| 124 | 124 |
|
| 125 | 125 |
Congratulations, you've created your first pull request to Docker. The next |
| 126 | 126 |
step is for you learn how to [participate in your PR's |
| 127 |
-review](/project/review-pr/). |
|
| 128 | 127 |
\ No newline at end of file |
| 128 |
+review](/project/review-pr/). |
| ... | ... |
@@ -172,8 +172,8 @@ To sync your repository: |
| 172 | 172 |
remote: Total 141 (delta 52), reused 46 (delta 46), pack-reused 66 |
| 173 | 173 |
Receiving objects: 100% (141/141), 112.43 KiB | 0 bytes/s, done. |
| 174 | 174 |
Resolving deltas: 100% (79/79), done. |
| 175 |
- From github.com:docker/docker |
|
| 176 |
- * branch master -> FETCH_HEAD |
|
| 175 |
+ From github.com:docker/docker |
|
| 176 |
+ * branch master -> FETCH_HEAD |
|
| 177 | 177 |
|
| 178 | 178 |
This command says get all the changes from the `master` branch belonging to |
| 179 | 179 |
the `upstream` remote. |
| ... | ... |
@@ -184,8 +184,8 @@ To sync your repository: |
| 184 | 184 |
First, rewinding head to replay your work on top of it... |
| 185 | 185 |
Fast-forwarded master to upstream/master. |
| 186 | 186 |
|
| 187 |
- This command writes all the commits from the upstream branch into your local |
|
| 188 |
- branch. |
|
| 187 |
+ This command applies all the commits from the upstream master to your local |
|
| 188 |
+ master. |
|
| 189 | 189 |
|
| 190 | 190 |
8. Check the status of your local branch. |
| 191 | 191 |
|
| ... | ... |
@@ -195,12 +195,12 @@ To sync your repository: |
| 195 | 195 |
(use "git push" to publish your local commits) |
| 196 | 196 |
nothing to commit, working directory clean |
| 197 | 197 |
|
| 198 |
- Your local repository now has any changes from the `upstream` remote. You |
|
| 198 |
+ Your local repository now has all the changes from the `upstream` remote. You |
|
| 199 | 199 |
need to push the changes to your own remote fork which is `origin master`. |
| 200 | 200 |
|
| 201 | 201 |
9. Push the rebased master to `origin master`. |
| 202 | 202 |
|
| 203 |
- $ git push origin |
|
| 203 |
+ $ git push origin master |
|
| 204 | 204 |
Username for 'https://github.com': moxiegirl |
| 205 | 205 |
Password for 'https://moxiegirl@github.com': |
| 206 | 206 |
Counting objects: 223, done. |
| ... | ... |
@@ -228,8 +228,8 @@ To sync your repository: |
| 228 | 228 |
Current branch 11038-fix-rhel-link is up to date. |
| 229 | 229 |
|
| 230 | 230 |
At this point, your local branch, your remote repository, and the Docker |
| 231 |
- repository all have identical code. You are ready to make changesfor your |
|
| 232 |
- issues. |
|
| 231 |
+ repository all have identical code. You are ready to make changes for your |
|
| 232 |
+ issue. |
|
| 233 | 233 |
|
| 234 | 234 |
|
| 235 | 235 |
## Where to go next |
| ... | ... |
@@ -88,7 +88,7 @@ contributions through pseudonyms. |
| 88 | 88 |
As you change code in your fork, you'll want to keep it in sync with the changes |
| 89 | 89 |
others make in the `docker/docker` repository. To make syncing easier, you'll |
| 90 | 90 |
also add a _remote_ called `upstream` that points to `docker/docker`. A remote |
| 91 |
-is just another a project version hosted on the internet or network. |
|
| 91 |
+is just another project version hosted on the internet or network. |
|
| 92 | 92 |
|
| 93 | 93 |
To configure your username, email, and add a remote: |
| 94 | 94 |
|
| ... | ... |
@@ -171,7 +171,7 @@ the branch to your fork on GitHub: |
| 171 | 171 |
|
| 172 | 172 |
You can use any text editor you are comfortable with. |
| 173 | 173 |
|
| 174 |
-6. Close and save the file. |
|
| 174 |
+6. Save and close the file. |
|
| 175 | 175 |
|
| 176 | 176 |
7. Check the status of your branch. |
| 177 | 177 |
|
| ... | ... |
@@ -82,7 +82,7 @@ your user to the `docker` group as follows: |
| 82 | 82 |
|
| 83 | 83 |
$ sudo usermod -aG docker ubuntu |
| 84 | 84 |
|
| 85 |
-You must log out and back in for this modification to take effect. |
|
| 85 |
+You must log out and log back in for this modification to take effect. |
|
| 86 | 86 |
|
| 87 | 87 |
|
| 88 | 88 |
## Where to go next |
| ... | ... |
@@ -109,7 +109,7 @@ Follow this workflow as you work: |
| 109 | 109 |
|
| 110 | 110 |
9. Push your change to your repository. |
| 111 | 111 |
|
| 112 |
- $ git push origin |
|
| 112 |
+ $ git push origin 11038-fix-rhel-link |
|
| 113 | 113 |
Username for 'https://github.com': moxiegirl |
| 114 | 114 |
Password for 'https://moxiegirl@github.com': |
| 115 | 115 |
Counting objects: 60, done. |
| ... | ... |
@@ -145,58 +145,46 @@ After you push a new branch, you should verify it on GitHub: |
| 145 | 145 |
|
| 146 | 146 |
You should pull and rebase frequently as you work. |
| 147 | 147 |
|
| 148 |
-1. Return to the terminal on your local machine. |
|
| 148 |
+1. Return to the terminal on your local machine and checkout your |
|
| 149 |
+ feature branch in your local `docker-fork` repository. |
|
| 149 | 150 |
|
| 150 |
-2. Make sure you are in your branch. |
|
| 151 |
+2. Fetch any last minute changes from `docker/docker`. |
|
| 151 | 152 |
|
| 152 |
- $ git checkout 11038-fix-rhel-link |
|
| 153 |
+ $ git fetch upstream master |
|
| 154 |
+ From github.com:docker/docker |
|
| 155 |
+ * branch master -> FETCH_HEAD |
|
| 153 | 156 |
|
| 154 |
-3. Fetch all the changes from the `upstream master` branch. |
|
| 157 |
+3. Start an interactive rebase. |
|
| 155 | 158 |
|
| 156 |
- $ git fetch upstream master |
|
| 159 |
+ $ git rebase -i upstream/master |
|
| 157 | 160 |
|
| 158 |
- This command says get all the changes from the `master` branch belonging to |
|
| 159 |
- the `upstream` remote. |
|
| 161 |
+4. Rebase opens an editor with a list of commits. |
|
| 160 | 162 |
|
| 161 |
-4. Rebase your master with the local copy of Docker's `master` branch. |
|
| 163 |
+ pick 1a79f55 Tweak some of the other text for grammar |
|
| 164 |
+ pick 53e4983 Fix a link |
|
| 165 |
+ pick 3ce07bb Add a new line about RHEL |
|
| 162 | 166 |
|
| 163 |
- $ git rebase -i upstream/master |
|
| 164 |
- |
|
| 165 |
- This command starts an interactive rebase to rewrite all the commits from |
|
| 166 |
- Docker's `upstream/master` onto your local branch, and then re-apply each of |
|
| 167 |
- your commits on top of the upstream changes. If you aren't familiar or |
|
| 168 |
- comfortable with rebase, you can <a |
|
| 169 |
- href="http://nathanleclaire.com/blog/2014/09/14/dont-be-scared-of-git- |
|
| 170 |
- rebase" target="_blank">learn more about rebasing</a> on the web. |
|
| 171 |
- |
|
| 172 |
-5. Rebase opens an editor with a list of commits. |
|
| 167 |
+5. Replace the `pick` keyword with `squash` on all but the first commit. |
|
| 173 | 168 |
|
| 174 |
- pick 1a79f55 Tweak some of the other text for grammar |
|
| 175 |
- pick 53e4983 Fix a link |
|
| 176 |
- pick 3ce07bb Add a new line about RHEL |
|
| 177 |
- |
|
| 178 |
- If you run into trouble, `git --rebase abort` removes any changes and gets |
|
| 179 |
- you back to where you started. |
|
| 169 |
+ pick 1a79f55 Tweak some of the other text for grammar |
|
| 170 |
+ squash 53e4983 Fix a link |
|
| 171 |
+ squash 3ce07bb Add a new line about RHEL |
|
| 180 | 172 |
|
| 181 |
-6. Squash the `pick` keyword with `squash` on all but the first commit. |
|
| 173 |
+ After you save the changes and quit from the editor, git starts |
|
| 174 |
+ the rebase, reporting the progress along the way. Sometimes |
|
| 175 |
+ your changes can conflict with the work of others. If git |
|
| 176 |
+ encounters a conflict, it stops the rebase, and prints guidance |
|
| 177 |
+ for how to correct the conflict. |
|
| 182 | 178 |
|
| 183 |
- pick 1a79f55 Tweak some of the other text for grammar |
|
| 184 |
- squash 53e4983 Fix a link |
|
| 185 |
- squash 3ce07bb Add a new line about RHEL |
|
| 179 |
+6. Edit and save your commit message. |
|
| 186 | 180 |
|
| 187 |
- After closing the file, `git` opens your editor again to edit the commit |
|
| 188 |
- message. |
|
| 181 |
+ `git commit -s` |
|
| 189 | 182 |
|
| 190 |
-7. Edit the commit message to reflect the entire change. |
|
| 183 |
+ Make sure your message includes <a href="./set-up-git" target="_blank>your signature</a>. |
|
| 191 | 184 |
|
| 192 |
- Make sure you include your signature. |
|
| 185 |
+7. Force push any changes to your fork on GitHub. |
|
| 193 | 186 |
|
| 194 |
-8. Push any changes to your fork on GitHub. |
|
| 195 |
- |
|
| 196 |
- The rebase rewrote history, so you'll need to use the `-f` or `--force` flag |
|
| 197 |
- to push your change. |
|
| 198 |
- |
|
| 199 |
- $ git push -f origin 11038-fix-rhel-link |
|
| 187 |
+ $ git push -f origin 11038-fix-rhel-link |
|
| 200 | 188 |
|
| 201 | 189 |
|
| 202 | 190 |
## Where to go next |