|
| 1 | +# Contribution Guidelines |
| 2 | + |
| 3 | +Development happens on GitHub. |
| 4 | +Issues are used for bugs and actionable items and longer discussions can happen on the [mailing list](#mailing-list). |
| 5 | + |
| 6 | +The content of this repository is licensed under the [Apache License, Version 2.0](LICENSE). |
| 7 | + |
| 8 | +## Code of Conduct |
| 9 | + |
| 10 | +Participation in the Open Container community is governed by [Open Container Code of Conduct][code-of-conduct]. |
| 11 | + |
| 12 | +## Meetings |
| 13 | + |
| 14 | +The contributors and maintainers of all OCI projects have monthly meetings, which are usually at 2:00 PM (USA Pacific) on the first Wednesday of every month. |
| 15 | +There is an [iCalendar][rfc5545] format for the meetings [here][meeting.ics]. |
| 16 | +Everyone is welcome to participate via [UberConference web][UberConference] or audio-only: +1 415 968 0849 (no PIN needed). |
| 17 | +An initial agenda will be posted to the [mailing list](#mailing-list) in the week before each meeting, and everyone is welcome to propose additional topics or suggest other agenda alterations there. |
| 18 | +Minutes are posted to the [mailing list](#mailing-list) and minutes from past calls are archived [here][minutes], with minutes from especially old meetings (September 2015 and earlier) archived [here][runtime-wiki]. |
| 19 | + |
| 20 | +## Mailing list |
| 21 | + |
| 22 | +You can subscribe and browse the mailing list on [Google Groups][mailing-list]. |
| 23 | + |
| 24 | +## IRC |
| 25 | + |
| 26 | +OCI discussion happens on #opencontainers on [Freenode][] ([logs][irc-logs]). |
| 27 | + |
| 28 | +## Git |
| 29 | + |
| 30 | +### Security issues |
| 31 | + |
| 32 | +If you are reporting a security issue, do not create an issue or file a pull |
| 33 | +request on GitHub. Instead, disclose the issue responsibly by sending an email |
| 34 | +to [email protected] (which is inhabited only by the maintainers of |
| 35 | +the various OCI projects). |
| 36 | + |
| 37 | +### Pull requests are always welcome |
| 38 | + |
| 39 | +We are always thrilled to receive pull requests, and do our best to |
| 40 | +process them as fast as possible. Not sure if that typo is worth a pull |
| 41 | +request? Do it! We will appreciate it. |
| 42 | + |
| 43 | +If your pull request is not accepted on the first try, don't be |
| 44 | +discouraged! If there's a problem with the implementation, hopefully you |
| 45 | +received feedback on what to improve. |
| 46 | + |
| 47 | +We're trying very hard to keep the project lean and focused. We don't want it |
| 48 | +to do everything for everybody. This means that we might decide against |
| 49 | +incorporating a new feature. |
| 50 | + |
| 51 | +### Conventions |
| 52 | + |
| 53 | +Fork the repo and make changes on your fork in a feature branch. |
| 54 | +For larger bugs and enhancements, consider filing a leader issue or mailing-list thread for discussion that is independent of the implementation. |
| 55 | +Small changes or changes that have been discussed on the [project mailing list](#mailing-list) may be submitted without a leader issue. |
| 56 | + |
| 57 | +If the project has a test suite, submit unit tests for your changes. Take a |
| 58 | +look at existing tests for inspiration. Run the full test suite on your branch |
| 59 | +before submitting a pull request. |
| 60 | + |
| 61 | +Update the documentation when creating or modifying features. Test |
| 62 | +your documentation changes for clarity, concision, and correctness, as |
| 63 | +well as a clean documentation build. |
| 64 | + |
| 65 | +Pull requests descriptions should be as clear as possible and include a |
| 66 | +reference to all the issues that they address. |
| 67 | + |
| 68 | +Commit messages must start with a capitalized and short summary |
| 69 | +written in the imperative, followed by an optional, more detailed |
| 70 | +explanatory text which is separated from the summary by an empty line. |
| 71 | + |
| 72 | +Code review comments may be added to your pull request. Discuss, then make the |
| 73 | +suggested modifications and push additional commits to your feature branch. Be |
| 74 | +sure to post a comment after pushing. The new commits will show up in the pull |
| 75 | +request automatically, but the reviewers will not be notified unless you |
| 76 | +comment. |
| 77 | + |
| 78 | +Before the pull request is merged, make sure that you squash your commits into |
| 79 | +logical units of work using `git rebase -i` and `git push -f`. After every |
| 80 | +commit the test suite (if any) should be passing. Include documentation changes |
| 81 | +in the same commit so that a revert would remove all traces of the feature or |
| 82 | +fix. |
| 83 | + |
| 84 | +Commits that fix or close an issue should include a reference like `Closes #XXX` |
| 85 | +or `Fixes #XXX`, which will automatically close the issue when merged. |
| 86 | + |
| 87 | +### Sign your work |
| 88 | + |
| 89 | +The sign-off is a simple line at the end of the explanation for the |
| 90 | +patch, which certifies that you wrote it or otherwise have the right to |
| 91 | +pass it on as an open-source patch. The rules are pretty simple: if you |
| 92 | +can certify the below (from [developercertificate.org][]): |
| 93 | + |
| 94 | +``` |
| 95 | +Developer Certificate of Origin |
| 96 | +Version 1.1 |
| 97 | +
|
| 98 | +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 99 | +1 Letterman Drive |
| 100 | +Suite D4700 |
| 101 | +San Francisco, CA, 94129 |
| 102 | +
|
| 103 | +Everyone is permitted to copy and distribute verbatim copies of this |
| 104 | +license document, but changing it is not allowed. |
| 105 | +
|
| 106 | +
|
| 107 | +Developer's Certificate of Origin 1.1 |
| 108 | +
|
| 109 | +By making a contribution to this project, I certify that: |
| 110 | +
|
| 111 | +(a) The contribution was created in whole or in part by me and I |
| 112 | + have the right to submit it under the open source license |
| 113 | + indicated in the file; or |
| 114 | +
|
| 115 | +(b) The contribution is based upon previous work that, to the best |
| 116 | + of my knowledge, is covered under an appropriate open source |
| 117 | + license and I have the right under that license to submit that |
| 118 | + work with modifications, whether created in whole or in part |
| 119 | + by me, under the same open source license (unless I am |
| 120 | + permitted to submit under a different license), as indicated |
| 121 | + in the file; or |
| 122 | +
|
| 123 | +(c) The contribution was provided directly to me by some other |
| 124 | + person who certified (a), (b) or (c) and I have not modified |
| 125 | + it. |
| 126 | +
|
| 127 | +(d) I understand and agree that this project and the contribution |
| 128 | + are public and that a record of the contribution (including all |
| 129 | + personal information I submit with it, including my sign-off) is |
| 130 | + maintained indefinitely and may be redistributed consistent with |
| 131 | + this project or the open source license(s) involved. |
| 132 | +``` |
| 133 | + |
| 134 | +then you just add a line to every git commit message: |
| 135 | + |
| 136 | + Signed-off-by: Joe Smith <[email protected]> |
| 137 | + |
| 138 | +using your real name (sorry, no pseudonyms or anonymous contributions.) |
| 139 | + |
| 140 | +You can add the sign off when creating the git commit via `git commit -s`. |
| 141 | + |
| 142 | +[code-of-conduct]: https://github.com/opencontainers/tob/blob/d2f9d68c1332870e40693fe077d311e0742bc73d/code-of-conduct.md |
| 143 | +[developercertificate.org]: http://developercertificate.org/ |
| 144 | +[Freenode]: https://freenode.net/ |
| 145 | +[irc-logs]: http://ircbot.wl.linuxfoundation.org/eavesdrop/%23opencontainers/ |
| 146 | +[mailing-list]: https://groups.google.com/a/opencontainers.org/forum/#!forum/dev |
| 147 | +[meeting.ics]: meeting.ics |
| 148 | +[minutes]: http://ircbot.wl.linuxfoundation.org/meetings/opencontainers/ |
| 149 | +[runtime-wiki]: https://github.com/opencontainers/runtime-spec/wiki |
| 150 | +[UberConference]: https://www.uberconference.com/opencontainers |
0 commit comments