Browse code
Contributing to Docker
Solomon Hykes authored on 2013/03/18 11:32:06Showing 1 changed files
| ... | ... |
@@ -180,6 +180,51 @@ Expose a service on a TCP port |
| 180 | 180 |
echo "Daemon received: $(docker logs $JOB)" |
| 181 | 181 |
``` |
| 182 | 182 |
|
| 183 |
+Contributing to Docker |
|
| 184 |
+====================== |
|
| 185 |
+ |
|
| 186 |
+Want to hack on Docker? Awesome! Here are instructions to get you started. They are probably not perfect, please let us know if anything feels wrong or incomplete. |
|
| 187 |
+ |
|
| 188 |
+Contribution guidelines |
|
| 189 |
+----------------------- |
|
| 190 |
+ |
|
| 191 |
+### Pull requests are always welcome |
|
| 192 |
+ |
|
| 193 |
+We are always thrilled to receive pull requests, and do our best to process them as fast as possible. Not sure if that typo is worth a pull request? Do it! We will appreciate it. |
|
| 194 |
+ |
|
| 195 |
+If your pull request is not accepted on the first try, don't be discouraged! If there's a problen with the implementation, hopefully you received feedback on what to improve. |
|
| 196 |
+ |
|
| 197 |
+We're trying very hard to keep Docker lean and focused. We don't want it to do everything for everybody. This means that we might decide against incorporating a new feature. |
|
| 198 |
+However there might be a way to implement that feature *on top of* docker. |
|
| 199 |
+ |
|
| 200 |
+### Discuss your design on the mailing list |
|
| 201 |
+ |
|
| 202 |
+We recommend discussing your plans [on the mailing list](https://groups.google.com/forum/?fromgroups#!forum/docker-club) before starting to code - especially for more ambitious contributions. This gives other contributors a chance to point |
|
| 203 |
+you in the right direction, give feedback on your design, and maybe point out if someone else is working on the same thing. |
|
| 204 |
+ |
|
| 205 |
+### Create issues... |
|
| 206 |
+ |
|
| 207 |
+Any significant improvement should be documented as a github issue before anybody start working on it. |
|
| 208 |
+ |
|
| 209 |
+### ...but check for existing issues first! |
|
| 210 |
+ |
|
| 211 |
+Please take a moment to check that an issue doesn't already exist documenting your bug report or improvement proposal. |
|
| 212 |
+If it does, it never hurts to add a quick "+1" or "I have this problem too". This will help prioritize the most common problems and requests. |
|
| 213 |
+ |
|
| 214 |
+ |
|
| 215 |
+### Write tests |
|
| 216 |
+ |
|
| 217 |
+Golang has a great testing suite built in: use it! Take a look at existing tests for inspiration. |
|
| 218 |
+ |
|
| 219 |
+ |
|
| 220 |
+ |
|
| 221 |
+Setting up a dev environment |
|
| 222 |
+---------------------------- |
|
| 223 |
+ |
|
| 224 |
+Coming soon! |
|
| 225 |
+ |
|
| 226 |
+ |
|
| 227 |
+ |
|
| 183 | 228 |
|
| 184 | 229 |
What is a Standard Container? |
| 185 | 230 |
============================= |