* Fixed some uses of docker v. Docker
* Formatting and line wrapping.
* Spelling errors and grammar fixes.
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
| ... | ... |
@@ -6,12 +6,17 @@ feels wrong or incomplete. |
| 6 | 6 |
|
| 7 | 7 |
## Reporting Issues |
| 8 | 8 |
|
| 9 |
-When reporting [issues](https://github.com/dotcloud/docker/issues) |
|
| 10 |
-on GitHub please include your host OS (Ubuntu 12.04, Fedora 19, etc), |
|
| 11 |
-the output of `uname -a` and the output of `docker version` along with |
|
| 12 |
-the output of `docker -D info`. Please include the steps required to reproduce |
|
| 13 |
-the problem if possible and applicable. |
|
| 14 |
-This information will help us review and fix your issue faster. |
|
| 9 |
+When reporting [issues](https://github.com/dotcloud/docker/issues) on |
|
| 10 |
+GitHub please include your host OS (Ubuntu 12.04, Fedora 19, etc). |
|
| 11 |
+Please include: |
|
| 12 |
+ |
|
| 13 |
+* The output of `uname -a`. |
|
| 14 |
+* The output of `docker version`. |
|
| 15 |
+* The output of `docker -D info`. |
|
| 16 |
+ |
|
| 17 |
+Please also include the steps required to reproduce the problem if |
|
| 18 |
+possible and applicable. This information will help us review and fix |
|
| 19 |
+your issue faster. |
|
| 15 | 20 |
|
| 16 | 21 |
## Build Environment |
| 17 | 22 |
|
| ... | ... |
@@ -34,7 +39,7 @@ received feedback on what to improve. |
| 34 | 34 |
We're trying very hard to keep Docker lean and focused. We don't want it |
| 35 | 35 |
to do everything for everybody. This means that we might decide against |
| 36 | 36 |
incorporating a new feature. However, there might be a way to implement |
| 37 |
-that feature *on top of* docker. |
|
| 37 |
+that feature *on top of* Docker. |
|
| 38 | 38 |
|
| 39 | 39 |
### Discuss your design on the mailing list |
| 40 | 40 |
|
| ... | ... |
@@ -60,12 +65,12 @@ help prioritize the most common problems and requests. |
| 60 | 60 |
|
| 61 | 61 |
### Conventions |
| 62 | 62 |
|
| 63 |
-Fork the repo and make changes on your fork in a feature branch: |
|
| 63 |
+Fork the repository and make changes on your fork in a feature branch: |
|
| 64 | 64 |
|
| 65 |
-- If it's a bugfix branch, name it XXX-something where XXX is the number of the |
|
| 66 |
- issue |
|
| 65 |
+- If it's a bug fix branch, name it XXXX-something where XXXX is the number of the |
|
| 66 |
+ issue. |
|
| 67 | 67 |
- If it's a feature branch, create an enhancement issue to announce your |
| 68 |
- intentions, and name it XXX-something where XXX is the number of the issue. |
|
| 68 |
+ intentions, and name it XXXX-something where XXXX is the number of the issue. |
|
| 69 | 69 |
|
| 70 | 70 |
Submit unit tests for your changes. Go has a great test framework built in; use |
| 71 | 71 |
it! Take a look at existing tests for inspiration. Run the full test suite on |
| ... | ... |
@@ -73,12 +78,12 @@ your branch before submitting a pull request. |
| 73 | 73 |
|
| 74 | 74 |
Update the documentation when creating or modifying features. Test |
| 75 | 75 |
your documentation changes for clarity, concision, and correctness, as |
| 76 |
-well as a clean documentation build. See ``docs/README.md`` for more |
|
| 77 |
-information on building the docs and how docs get released. |
|
| 76 |
+well as a clean documentation build. See `docs/README.md` for more |
|
| 77 |
+information on building the docs and how they get released. |
|
| 78 | 78 |
|
| 79 | 79 |
Write clean code. Universally formatted code promotes ease of writing, reading, |
| 80 | 80 |
and maintenance. Always run `gofmt -s -w file.go` on each changed file before |
| 81 |
-committing your changes. Most editors have plugins that do this automatically. |
|
| 81 |
+committing your changes. Most editors have plug-ins that do this automatically. |
|
| 82 | 82 |
|
| 83 | 83 |
Pull requests descriptions should be as clear as possible and include a |
| 84 | 84 |
reference to all the issues that they address. |
| ... | ... |
@@ -100,21 +105,22 @@ logical units of work using `git rebase -i` and `git push -f`. After every |
| 100 | 100 |
commit the test suite should be passing. Include documentation changes in the |
| 101 | 101 |
same commit so that a revert would remove all traces of the feature or fix. |
| 102 | 102 |
|
| 103 |
-Commits that fix or close an issue should include a reference like `Closes #XXX` |
|
| 104 |
-or `Fixes #XXX`, which will automatically close the issue when merged. |
|
| 103 |
+Commits that fix or close an issue should include a reference like |
|
| 104 |
+`Closes #XXXX` or `Fixes #XXXX`, which will automatically close the |
|
| 105 |
+issue when merged. |
|
| 105 | 106 |
|
| 106 |
-Please do not add yourself to the AUTHORS file, as it is regenerated |
|
| 107 |
+Please do not add yourself to the `AUTHORS` file, as it is regenerated |
|
| 107 | 108 |
regularly from the Git history. |
| 108 | 109 |
|
| 109 | 110 |
### Merge approval |
| 110 | 111 |
|
| 111 |
-Docker maintainers use LGTM (looks good to me) in comments on the code review |
|
| 112 |
+Docker maintainers use LGTM (Looks Good To Me) in comments on the code review |
|
| 112 | 113 |
to indicate acceptance. |
| 113 | 114 |
|
| 114 | 115 |
A change requires LGTMs from an absolute majority of the maintainers of each |
| 115 |
-component affected. For example, if a change affects docs/ and registry/, it |
|
| 116 |
-needs an absolute majority from the maintainers of docs/ AND, separately, an |
|
| 117 |
-absolute majority of the maintainers of registry. |
|
| 116 |
+component affected. For example, if a change affects `docs/` and `registry/`, it |
|
| 117 |
+needs an absolute majority from the maintainers of `docs/` AND, separately, an |
|
| 118 |
+absolute majority of the maintainers of `registry/`. |
|
| 118 | 119 |
|
| 119 | 120 |
For more details see [MAINTAINERS.md](hack/MAINTAINERS.md) |
| 120 | 121 |
|
| ... | ... |
@@ -137,7 +143,6 @@ San Francisco, CA 94110 USA |
| 137 | 137 |
Everyone is permitted to copy and distribute verbatim copies of this |
| 138 | 138 |
license document, but changing it is not allowed. |
| 139 | 139 |
|
| 140 |
- |
|
| 141 | 140 |
Developer's Certificate of Origin 1.1 |
| 142 | 141 |
|
| 143 | 142 |
By making a contribution to this project, I certify that: |
| ... | ... |
@@ -165,20 +170,20 @@ By making a contribution to this project, I certify that: |
| 165 | 165 |
this project or the open source license(s) involved. |
| 166 | 166 |
``` |
| 167 | 167 |
|
| 168 |
-then you just add a line to every git commit message: |
|
| 168 |
+Then you just add a line to every git commit message: |
|
| 169 | 169 |
|
| 170 | 170 |
Docker-DCO-1.1-Signed-off-by: Joe Smith <joe.smith@email.com> (github: github_handle) |
| 171 | 171 |
|
| 172 |
-using your real name (sorry, no pseudonyms or anonymous contributions.) |
|
| 172 |
+Using your real name (sorry, no pseudonyms or anonymous contributions.) |
|
| 173 | 173 |
|
| 174 |
-One way to automate this, is customise your get ``commit.template`` by adding |
|
| 175 |
-a ``prepare-commit-msg`` hook to your docker checkout: |
|
| 174 |
+One way to automate this, is customize your git `commit.template` by adding |
|
| 175 |
+a `prepare-commit-msg` hook to your Docker repository: |
|
| 176 | 176 |
|
| 177 | 177 |
``` |
| 178 | 178 |
curl -o .git/hooks/prepare-commit-msg https://raw.githubusercontent.com/dotcloud/docker/master/contrib/prepare-commit-msg.hook && chmod +x .git/hooks/prepare-commit-msg |
| 179 | 179 |
``` |
| 180 | 180 |
|
| 181 |
-* Note: the above script expects to find your GitHub user name in ``git config --get github.user`` |
|
| 181 |
+* Note: the above script expects to find your GitHub user name in `git config --get github.user` |
|
| 182 | 182 |
|
| 183 | 183 |
#### Small patch exception |
| 184 | 184 |
|
| ... | ... |
@@ -194,11 +199,12 @@ If you have any questions, please refer to the FAQ in the [docs](http://docs.doc |
| 194 | 194 |
|
| 195 | 195 |
### How can I become a maintainer? |
| 196 | 196 |
|
| 197 |
-* Step 1: learn the component inside out |
|
| 198 |
-* Step 2: make yourself useful by contributing code, bugfixes, support etc. |
|
| 199 |
-* Step 3: volunteer on the irc channel (#docker@freenode) |
|
| 200 |
-* Step 4: propose yourself at a scheduled docker meeting in #docker-dev |
|
| 197 |
+* Step 1: Learn the component inside out |
|
| 198 |
+* Step 2: Make yourself useful by contributing code, bug fixes, support etc. |
|
| 199 |
+* Step 3: Volunteer on the IRC channel (#docker at Freenode) |
|
| 200 |
+* Step 4: Propose yourself at a scheduled docker meeting in #docker-dev |
|
| 201 | 201 |
|
| 202 |
-Don't forget: being a maintainer is a time investment. Make sure you will have time to make yourself available. |
|
| 203 |
-You don't have to be a maintainer to make a difference on the project! |
|
| 202 |
+Don't forget: being a maintainer is a time investment. Make sure you |
|
| 203 |
+will have time to make yourself available. You don't have to be a |
|
| 204 |
+maintainer to make a difference on the project! |
|
| 204 | 205 |
|