|
| 1 | +## Contribution Guidelines |
| 2 | + |
| 3 | +### Security issues |
| 4 | + |
| 5 | +If you are reporting a security issue, do not create an issue or file a pull |
| 6 | +request on GitHub. Instead, disclose the issue responsibly by sending an email |
| 7 | +to [email protected] (which is inhabited only by the maintainers of |
| 8 | +the various OCI projects). |
| 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 the project 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. |
| 23 | + |
| 24 | + |
| 25 | +### Conventions |
| 26 | + |
| 27 | +Fork the repo and make changes on your fork in a feature branch. |
| 28 | +For larger bugs and enhancements, consider filing a leader issue or mailing-list thread for discussion that is independent of the implementation. |
| 29 | +Small changes or changes that have been discussed on the project mailing list may be submitted without a leader issue. |
| 30 | + |
| 31 | +If the project has a test suite, submit unit tests for your changes. Take a |
| 32 | +look at existing tests for inspiration. Run the full test suite on your branch |
| 33 | +before submitting a pull request. |
| 34 | + |
| 35 | +Update the documentation when creating or modifying features. Test |
| 36 | +your documentation changes for clarity, concision, and correctness, as |
| 37 | +well as a clean documentation build. See ``docs/README.md`` for more |
| 38 | +information on building the docs and how docs get released. |
| 39 | + |
| 40 | +Write clean code. Universally formatted code promotes ease of writing, reading, |
| 41 | +and maintenance. Always run `gofmt -s -w file.go` on each changed file before |
| 42 | +committing your changes. Most editors have plugins that do this automatically. |
| 43 | + |
| 44 | +Pull requests descriptions should be as clear as possible and include a |
| 45 | +reference to all the issues that they address. |
| 46 | + |
| 47 | +Commit messages must start with a capitalized and short summary |
| 48 | +written in the imperative, followed by an optional, more detailed |
| 49 | +explanatory text which is separated from the summary by an empty line. |
| 50 | + |
| 51 | +Code review comments may be added to your pull request. Discuss, then make the |
| 52 | +suggested modifications and push additional commits to your feature branch. Be |
| 53 | +sure to post a comment after pushing. The new commits will show up in the pull |
| 54 | +request automatically, but the reviewers will not be notified unless you |
| 55 | +comment. |
| 56 | + |
| 57 | +Before the pull request is merged, make sure that you squash your commits into |
| 58 | +logical units of work using `git rebase -i` and `git push -f`. After every |
| 59 | +commit the test suite (if any) should be passing. Include documentation changes |
| 60 | +in the same commit so that a revert would remove all traces of the feature or |
| 61 | +fix. |
| 62 | + |
| 63 | +Commits that fix or close an issue should include a reference like `Closes #XXX` |
| 64 | +or `Fixes #XXX`, which will automatically close the issue when merged. |
| 65 | + |
| 66 | +### Sign your work |
| 67 | + |
| 68 | +The sign-off is a simple line at the end of the explanation for the |
| 69 | +patch, which certifies that you wrote it or otherwise have the right to |
| 70 | +pass it on as an open-source patch. The rules are pretty simple: if you |
| 71 | +can certify the below (from |
| 72 | +[developercertificate.org](http://developercertificate.org/)): |
| 73 | + |
| 74 | +``` |
| 75 | +Developer Certificate of Origin |
| 76 | +Version 1.1 |
| 77 | +
|
| 78 | +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 79 | +660 York Street, Suite 102, |
| 80 | +San Francisco, CA 94110 USA |
| 81 | +
|
| 82 | +Everyone is permitted to copy and distribute verbatim copies of this |
| 83 | +license document, but changing it is not allowed. |
| 84 | +
|
| 85 | +
|
| 86 | +Developer's Certificate of Origin 1.1 |
| 87 | +
|
| 88 | +By making a contribution to this project, I certify that: |
| 89 | +
|
| 90 | +(a) The contribution was created in whole or in part by me and I |
| 91 | + have the right to submit it under the open source license |
| 92 | + indicated in the file; or |
| 93 | +
|
| 94 | +(b) The contribution is based upon previous work that, to the best |
| 95 | + of my knowledge, is covered under an appropriate open source |
| 96 | + license and I have the right under that license to submit that |
| 97 | + work with modifications, whether created in whole or in part |
| 98 | + by me, under the same open source license (unless I am |
| 99 | + permitted to submit under a different license), as indicated |
| 100 | + in the file; or |
| 101 | +
|
| 102 | +(c) The contribution was provided directly to me by some other |
| 103 | + person who certified (a), (b) or (c) and I have not modified |
| 104 | + it. |
| 105 | +
|
| 106 | +(d) I understand and agree that this project and the contribution |
| 107 | + are public and that a record of the contribution (including all |
| 108 | + personal information I submit with it, including my sign-off) is |
| 109 | + maintained indefinitely and may be redistributed consistent with |
| 110 | + this project or the open source license(s) involved. |
| 111 | +``` |
| 112 | + |
| 113 | +then you just add a line to every git commit message: |
| 114 | + |
| 115 | + Signed-off-by: Joe Smith <[email protected]> |
| 116 | + |
| 117 | +using your real name (sorry, no pseudonyms or anonymous contributions.) |
| 118 | + |
| 119 | +You can add the sign off when creating the git commit via `git commit -s`. |
0 commit comments