|
| 1 | +# Contributing to Docker open source projects |
| 2 | + |
| 3 | +Want to hack on this project? Awesome! Here are instructions to get you started. |
| 4 | + |
| 5 | +This project is a part of the [Docker](https://www.docker.com) project, and follows |
| 6 | +the same rules and principles. If you're already familiar with the way |
| 7 | +Docker does things, you'll feel right at home. |
| 8 | + |
| 9 | +Otherwise, go read Docker's |
| 10 | +[contributions guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md), |
| 11 | +[issue triaging](https://github.com/docker/docker/blob/master/project/ISSUE-TRIAGE.md), |
| 12 | +[review process](https://github.com/docker/docker/blob/master/project/REVIEWING.md) and |
| 13 | +[branches and tags](https://github.com/docker/docker/blob/master/project/BRANCHES-AND-TAGS.md). |
| 14 | + |
| 15 | +For an in-depth description of our contribution process, visit the |
| 16 | +contributors guide: [Understand how to contribute](https://docs.docker.com/opensource/workflow/make-a-contribution/) |
| 17 | + |
| 18 | +### Sign your work |
| 19 | + |
| 20 | +The sign-off is a simple line at the end of the explanation for the patch. Your |
| 21 | +signature certifies that you wrote the patch or otherwise have the right to pass |
| 22 | +it on as an open-source patch. The rules are pretty simple: if you can certify |
| 23 | +the below (from [developercertificate.org](http://developercertificate.org/)): |
| 24 | + |
| 25 | +``` |
| 26 | +Developer Certificate of Origin |
| 27 | +Version 1.1 |
| 28 | +
|
| 29 | +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 30 | +660 York Street, Suite 102, |
| 31 | +San Francisco, CA 94110 USA |
| 32 | +
|
| 33 | +Everyone is permitted to copy and distribute verbatim copies of this |
| 34 | +license document, but changing it is not allowed. |
| 35 | +
|
| 36 | +Developer's Certificate of Origin 1.1 |
| 37 | +
|
| 38 | +By making a contribution to this project, I certify that: |
| 39 | +
|
| 40 | +(a) The contribution was created in whole or in part by me and I |
| 41 | + have the right to submit it under the open source license |
| 42 | + indicated in the file; or |
| 43 | +
|
| 44 | +(b) The contribution is based upon previous work that, to the best |
| 45 | + of my knowledge, is covered under an appropriate open source |
| 46 | + license and I have the right under that license to submit that |
| 47 | + work with modifications, whether created in whole or in part |
| 48 | + by me, under the same open source license (unless I am |
| 49 | + permitted to submit under a different license), as indicated |
| 50 | + in the file; or |
| 51 | +
|
| 52 | +(c) The contribution was provided directly to me by some other |
| 53 | + person who certified (a), (b) or (c) and I have not modified |
| 54 | + it. |
| 55 | +
|
| 56 | +(d) I understand and agree that this project and the contribution |
| 57 | + are public and that a record of the contribution (including all |
| 58 | + personal information I submit with it, including my sign-off) is |
| 59 | + maintained indefinitely and may be redistributed consistent with |
| 60 | + this project or the open source license(s) involved. |
| 61 | +``` |
| 62 | + |
| 63 | +Then you just add a line to every git commit message: |
| 64 | + |
| 65 | + Signed-off-by: Joe Smith <[email protected]> |
| 66 | + |
| 67 | +Use your real name (sorry, no pseudonyms or anonymous contributions.) |
| 68 | + |
| 69 | +If you set your `user.name` and `user.email` git configs, you can sign your |
| 70 | +commit automatically with `git commit -s`. |
0 commit comments