Browse code
add contributing guidlines md file
John Costa authored on 2013/03/29 09:04:21Showing 1 changed files
| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,69 @@ |
| 0 |
+# Contributing to Docker |
|
| 1 |
+ |
|
| 2 |
+Want to hack on Docker? Awesome! There are instructions to get you |
|
| 3 |
+started on the website: http://docker.io/gettingstarted.html |
|
| 4 |
+ |
|
| 5 |
+They are probably not perfect, please let us know if anything feels |
|
| 6 |
+wrong or incomplete. |
|
| 7 |
+ |
|
| 8 |
+## Contribution guidelines |
|
| 9 |
+ |
|
| 10 |
+### Pull requests are always welcome |
|
| 11 |
+ |
|
| 12 |
+We are always thrilled to receive pull requests, and do our best to |
|
| 13 |
+process them as fast as possible. Not sure if that typo is worth a pull |
|
| 14 |
+request? Do it! We will appreciate it. |
|
| 15 |
+ |
|
| 16 |
+If your pull request is not accepted on the first try, don't be |
|
| 17 |
+discouraged! If there's a problem with the implementation, hopefully you |
|
| 18 |
+received feedback on what to improve. |
|
| 19 |
+ |
|
| 20 |
+We're trying very hard to keep Docker lean and focused. We don't want it |
|
| 21 |
+to do everything for everybody. This means that we might decide against |
|
| 22 |
+incorporating a new feature. However, there might be a way to implement |
|
| 23 |
+that feature *on top of* docker. |
|
| 24 |
+ |
|
| 25 |
+### Discuss your design on the mailing list |
|
| 26 |
+ |
|
| 27 |
+We recommend discussing your plans [on the mailing |
|
| 28 |
+list](https://groups.google.com/forum/?fromgroups#!forum/docker-club) |
|
| 29 |
+before starting to code - especially for more ambitious contributions. |
|
| 30 |
+This gives other contributors a chance to point you in the right |
|
| 31 |
+direction, give feedback on your design, and maybe point out if someone |
|
| 32 |
+else is working on the same thing. |
|
| 33 |
+ |
|
| 34 |
+### Create issues... |
|
| 35 |
+ |
|
| 36 |
+Any significant improvement should be documented as [a github |
|
| 37 |
+issue](https://github.com/dotcloud/docker/issues) before anybody |
|
| 38 |
+starts working on it. |
|
| 39 |
+ |
|
| 40 |
+### ...but check for existing issues first! |
|
| 41 |
+ |
|
| 42 |
+Please take a moment to check that an issue doesn't already exist |
|
| 43 |
+documenting your bug report or improvement proposal. If it does, it |
|
| 44 |
+never hurts to add a quick "+1" or "I have this problem too". This will |
|
| 45 |
+help prioritize the most common problems and requests. |
|
| 46 |
+ |
|
| 47 |
+### Conventions |
|
| 48 |
+ |
|
| 49 |
+Fork the repo and make changes on your fork in a feature branch: |
|
| 50 |
+ |
|
| 51 |
+- If it's a bugfix branch, name it XXX-something where XXX is the number of the issue |
|
| 52 |
+- If it's a feature branch, create an enhancement issue to announce your intentions, and name it XXX-something where XXX is the number of the issue. |
|
| 53 |
+ |
|
| 54 |
+Submit unit tests for your changes. Golang has a great testing suite built |
|
| 55 |
+in: use it! Take a look at existing tests for inspiration. Run the full test |
|
| 56 |
+suite against your change and the master. |
|
| 57 |
+ |
|
| 58 |
+Submit any relevant updates or additions to documentation. |
|
| 59 |
+ |
|
| 60 |
+Add clean code: |
|
| 61 |
+ |
|
| 62 |
+- Universally formatted code promotes ease of writing, reading, and maintenance. We suggest using gofmt before committing your changes. There's a git pre-commit hook made for doing so. |
|
| 63 |
+- curl -o .git/hooks/pre-commit https://raw.github.com/edsrzf/gofmt-git-hook/master/fmt-check && chmod +x .git/hooks/pre-commit |
|
| 64 |
+ |
|
| 65 |
+Pull requests descriptions should be as clear as possible and include a |
|
| 66 |
+referenced to all the issues that they address. |
|
| 67 |
+ |
|
| 68 |
+Add your name to the AUTHORS file. |