|
1 | | -If you have not previously done so, please fill out and submit the [Contributor License Agreement](https://cla.pivotal.io/sign/pivotal). |
| 1 | +# Contributing |
| 2 | + |
| 3 | +## Pull Request Process |
| 4 | + |
| 5 | +1. [Fork][fork] the repository. |
| 6 | +2. [Clone][clone] your fork repository. |
| 7 | +3. Create a branch for the issue: `git checkout -b {{BRANCH_NAME}}` |
| 8 | +4. Make any changes deemed necessary. |
| 9 | +5. Commit your changes: `git commit -s`\ |
| 10 | + _Learn more about the [sign-off](#sign-off-process) process below._ |
| 11 | +6. Push to GitHub: `git push origin {{BRANCH_NAME}}` |
| 12 | +7. [Create the pull request][create-pr]. |
| 13 | + |
| 14 | + |
| 15 | +## Sign-off Process |
| 16 | + |
| 17 | +Every commit contributed to this project must be signed-off. |
| 18 | + |
| 19 | +A sign-off is a single line added to your commit messages that certifies that you wrote and/or have the right to the |
| 20 | +contributed changes. |
| 21 | + |
| 22 | +The full text of the certification from [developercertificate.org](http://developercertificate.org/) is a follows: |
| 23 | +``` |
| 24 | +Developer Certificate of Origin |
| 25 | +Version 1.1 |
| 26 | +
|
| 27 | +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 28 | +1 Letterman Drive |
| 29 | +Suite D4700 |
| 30 | +San Francisco, CA, 94129 |
| 31 | +
|
| 32 | +Everyone is permitted to copy and distribute verbatim copies of this |
| 33 | +license document, but changing it is not allowed. |
| 34 | +
|
| 35 | +Developer's Certificate of Origin 1.1 |
| 36 | +
|
| 37 | +By making a contribution to this project, I certify that: |
| 38 | +
|
| 39 | +(a) The contribution was created in whole or in part by me and I |
| 40 | + have the right to submit it under the open source license |
| 41 | + indicated in the file; or |
| 42 | +
|
| 43 | +(b) The contribution is based upon previous work that, to the best |
| 44 | + of my knowledge, is covered under an appropriate open source |
| 45 | + license and I have the right under that license to submit that |
| 46 | + work with modifications, whether created in whole or in part |
| 47 | + by me, under the same open source license (unless I am |
| 48 | + permitted to submit under a different license), as indicated |
| 49 | + in the file; or |
| 50 | +
|
| 51 | +(c) The contribution was provided directly to me by some other |
| 52 | + person who certified (a), (b) or (c) and I have not modified |
| 53 | + it. |
| 54 | +
|
| 55 | +(d) I understand and agree that this project and the contribution |
| 56 | + are public and that a record of the contribution (including all |
| 57 | + personal information I submit with it, including my sign-off) is |
| 58 | + maintained indefinitely and may be redistributed consistent with |
| 59 | + this project or the open source license(s) involved. |
| 60 | +``` |
| 61 | + |
| 62 | +The signature should look as such: |
| 63 | + |
| 64 | + Signed-off-by: John Doe <john.doe@email.com> |
| 65 | + |
| 66 | +> Pro-tip: `git` can automatically add the signature by adding the `-s` flag to the commit command:\ |
| 67 | +> `git commit -s` |
| 68 | +
|
| 69 | +[fork]: https://help.github.com/en/github/getting-started-with-github/fork-a-repo |
| 70 | +[clone]: https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository |
| 71 | +[create-pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork |
0 commit comments