- added an image-link to the contributors guide
- added a link to forums.docker.com
- removed link to the docker-user Google Group, which is no longer in use
- remove the "Issue Report Template", because we now have a template for this on GitHub
- remove reference to the old "Docker-DCO-1.1-Signed-off-by" sign-off
- changed some none-https links to https
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
| ... | ... |
@@ -4,7 +4,7 @@ Want to hack on Docker? Awesome! We have a contributor's guide that explains |
| 4 | 4 |
[setting up a Docker development environment and the contribution |
| 5 | 5 |
process](https://docs.docker.com/opensource/project/who-written-for/). |
| 6 | 6 |
|
| 7 |
- |
|
| 7 |
+[](https://docs.docker.com/opensource/project/who-written-for/) |
|
| 8 | 8 |
|
| 9 | 9 |
This page contains information about reporting issues as well as some tips and |
| 10 | 10 |
guidelines useful to experienced open source contributors. Finally, make sure |
| ... | ... |
@@ -58,51 +58,11 @@ When sending lengthy log-files, consider posting them as a gist (https://gist.gi |
| 58 | 58 |
Don't forget to remove sensitive data from your logfiles before posting (you can |
| 59 | 59 |
replace those parts with "REDACTED"). |
| 60 | 60 |
|
| 61 |
-**Issue Report Template**: |
|
| 62 |
- |
|
| 63 |
-``` |
|
| 64 |
-Description of problem: |
|
| 65 |
- |
|
| 66 |
- |
|
| 67 |
-`docker version`: |
|
| 68 |
- |
|
| 69 |
- |
|
| 70 |
-`docker info`: |
|
| 71 |
- |
|
| 72 |
- |
|
| 73 |
-`uname -a`: |
|
| 74 |
- |
|
| 75 |
- |
|
| 76 |
-Environment details (AWS, VirtualBox, physical, etc.): |
|
| 77 |
- |
|
| 78 |
- |
|
| 79 |
-How reproducible: |
|
| 80 |
- |
|
| 81 |
- |
|
| 82 |
-Steps to Reproduce: |
|
| 83 |
-1. |
|
| 84 |
-2. |
|
| 85 |
-3. |
|
| 86 |
- |
|
| 87 |
- |
|
| 88 |
-Actual Results: |
|
| 89 |
- |
|
| 90 |
- |
|
| 91 |
-Expected Results: |
|
| 92 |
- |
|
| 93 |
- |
|
| 94 |
-Additional info: |
|
| 95 |
- |
|
| 96 |
- |
|
| 97 |
- |
|
| 98 |
-``` |
|
| 99 |
- |
|
| 100 |
- |
|
| 101 |
-##Quick contribution tips and guidelines |
|
| 61 |
+## Quick contribution tips and guidelines |
|
| 102 | 62 |
|
| 103 | 63 |
This section gives the experienced contributor some tips and guidelines. |
| 104 | 64 |
|
| 105 |
-###Pull requests are always welcome |
|
| 65 |
+### Pull requests are always welcome |
|
| 106 | 66 |
|
| 107 | 67 |
Not sure if that typo is worth a pull request? Found a bug and know how to fix |
| 108 | 68 |
it? Do it! We will appreciate it. Any significant improvement should be |
| ... | ... |
@@ -133,6 +93,14 @@ However, there might be a way to implement that feature *on top of* Docker. |
| 133 | 133 |
<col width="45%"> |
| 134 | 134 |
<col width="65%"> |
| 135 | 135 |
<tr> |
| 136 |
+ <td>Forums</td> |
|
| 137 |
+ <td> |
|
| 138 |
+ A public forum for users to discuss questions and explore current design patterns and |
|
| 139 |
+ best practices about Docker and related projects in the Docker Ecosystem. To participate, |
|
| 140 |
+ just log in with your Docker Hub account on <a href="https://forums.docker.com" target="_blank">https://forums.docker.com</a>. |
|
| 141 |
+ </td> |
|
| 142 |
+ </tr> |
|
| 143 |
+ <tr> |
|
| 136 | 144 |
<td>Internet Relay Chat (IRC)</td> |
| 137 | 145 |
<td> |
| 138 | 146 |
<p> |
| ... | ... |
@@ -142,19 +110,19 @@ However, there might be a way to implement that feature *on top of* Docker. |
| 142 | 142 |
IRC is a rich chat protocol but it can overwhelm new users. You can search |
| 143 | 143 |
<a href="https://botbot.me/freenode/docker/#" target="_blank">our chat archives</a>. |
| 144 | 144 |
</p> |
| 145 |
- Read our <a href="https://docs.docker.com/opensource/get-help/#irc-quickstart" target="_blank">IRC quickstart guide</a> for an easy way to get started. |
|
| 145 |
+ <p> |
|
| 146 |
+ Read our <a href="https://docs.docker.com/opensource/get-help/#irc-quickstart" target="_blank">IRC quickstart guide</a> |
|
| 147 |
+ for an easy way to get started. |
|
| 148 |
+ </p> |
|
| 146 | 149 |
</td> |
| 147 | 150 |
</tr> |
| 148 | 151 |
<tr> |
| 149 |
- <td>Google Groups</td> |
|
| 152 |
+ <td>Google Group</td> |
|
| 150 | 153 |
<td> |
| 151 |
- There are two groups. |
|
| 152 |
- <a href="https://groups.google.com/forum/#!forum/docker-user" target="_blank">Docker-user</a> |
|
| 153 |
- is for people using Docker containers. |
|
| 154 | 154 |
The <a href="https://groups.google.com/forum/#!forum/docker-dev" target="_blank">docker-dev</a> |
| 155 |
- group is for contributors and other people contributing to the Docker |
|
| 156 |
- project. |
|
| 157 |
- You can join them without an google account by sending an email to e.g. "docker-user+subscribe@googlegroups.com". |
|
| 155 |
+ group is for contributors and other people contributing to the Docker project. |
|
| 156 |
+ You can join them without an google account by sending an email to |
|
| 157 |
+ <a href="mailto:docker-dev+subscribe@googlegroups.com">docker-dev+subscribe@googlegroups.com</a>. |
|
| 158 | 158 |
After receiving the join-request message, you can simply reply to that to confirm the subscribtion. |
| 159 | 159 |
</td> |
| 160 | 160 |
</tr> |
| ... | ... |
@@ -308,10 +276,6 @@ Use your real name (sorry, no pseudonyms or anonymous contributions.) |
| 308 | 308 |
If you set your `user.name` and `user.email` git configs, you can sign your |
| 309 | 309 |
commit automatically with `git commit -s`. |
| 310 | 310 |
|
| 311 |
-Note that the old-style `Docker-DCO-1.1-Signed-off-by: ...` format is still |
|
| 312 |
-accepted, so there is no need to update outstanding pull requests to the new |
|
| 313 |
-format right away, but please do adjust your processes for future contributions. |
|
| 314 |
- |
|
| 315 | 311 |
### How can I become a maintainer? |
| 316 | 312 |
|
| 317 | 313 |
The procedures for adding new maintainers are explained in the |
| ... | ... |
@@ -431,6 +395,6 @@ The rules: |
| 431 | 431 |
guidelines. Since you've read all the rules, you now know that. |
| 432 | 432 |
|
| 433 | 433 |
If you are having trouble getting into the mood of idiomatic Go, we recommend |
| 434 |
-reading through [Effective Go](http://golang.org/doc/effective_go.html). The |
|
| 435 |
-[Go Blog](http://blog.golang.org/) is also a great resource. Drinking the |
|
| 434 |
+reading through [Effective Go](https://golang.org/doc/effective_go.html). The |
|
| 435 |
+[Go Blog](https://blog.golang.org) is also a great resource. Drinking the |
|
| 436 | 436 |
kool-aid is a lot easier than going thirsty. |