]>
Commit | Line | Data |
---|---|---|
9b12e4fe JC |
1 | # Contributing to go-units |
2 | ||
3 | Want to hack on go-units? Awesome! Here are instructions to get you started. | |
4 | ||
5 | go-units 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 | ### Sign your work | |
16 | ||
17 | The sign-off is a simple line at the end of the explanation for the patch. Your | |
18 | signature certifies that you wrote the patch or otherwise have the right to pass | |
19 | it on as an open-source patch. The rules are pretty simple: if you can certify | |
20 | the below (from [developercertificate.org](http://developercertificate.org/)): | |
21 | ||
22 | ``` | |
23 | Developer Certificate of Origin | |
24 | Version 1.1 | |
25 | ||
26 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | |
27 | 660 York Street, Suite 102, | |
28 | San Francisco, CA 94110 USA | |
29 | ||
30 | Everyone is permitted to copy and distribute verbatim copies of this | |
31 | license document, but changing it is not allowed. | |
32 | ||
33 | Developer's Certificate of Origin 1.1 | |
34 | ||
35 | By making a contribution to this project, I certify that: | |
36 | ||
37 | (a) The contribution was created in whole or in part by me and I | |
38 | have the right to submit it under the open source license | |
39 | indicated in the file; or | |
40 | ||
41 | (b) The contribution is based upon previous work that, to the best | |
42 | of my knowledge, is covered under an appropriate open source | |
43 | license and I have the right under that license to submit that | |
44 | work with modifications, whether created in whole or in part | |
45 | by me, under the same open source license (unless I am | |
46 | permitted to submit under a different license), as indicated | |
47 | in the file; or | |
48 | ||
49 | (c) The contribution was provided directly to me by some other | |
50 | person who certified (a), (b) or (c) and I have not modified | |
51 | it. | |
52 | ||
53 | (d) I understand and agree that this project and the contribution | |
54 | are public and that a record of the contribution (including all | |
55 | personal information I submit with it, including my sign-off) is | |
56 | maintained indefinitely and may be redistributed consistent with | |
57 | this project or the open source license(s) involved. | |
58 | ``` | |
59 | ||
60 | Then you just add a line to every git commit message: | |
61 | ||
62 | Signed-off-by: Joe Smith <joe.smith@email.com> | |
63 | ||
64 | Use your real name (sorry, no pseudonyms or anonymous contributions.) | |
65 | ||
66 | If you set your `user.name` and `user.email` git configs, you can sign your | |
67 | commit automatically with `git commit -s`. |