github.com/opencontainers/runtime-tools@v0.9.0/CONTRIBUTING.md (about) 1 ## Contribution Guidelines 2 3 ### Pull requests are always welcome 4 5 We are always thrilled to receive pull requests, and do our best to 6 process them as fast as possible. Not sure if that typo is worth a pull 7 request? Do it! We will appreciate it. 8 9 If your pull request is not accepted on the first try, don't be 10 discouraged! If there's a problem with the implementation, hopefully you 11 received feedback on what to improve. 12 13 We're trying very hard to keep the project lean and focused. We don't want it 14 to do everything for everybody. This means that we might decide against 15 incorporating a new feature. 16 17 18 ### Conventions 19 20 Fork the repo and make changes on your fork in a feature branch: 21 22 - If it's a bugfix branch, name it XXX-something where XXX is the number of the 23 issue 24 - If it's a feature branch, create an enhancement issue to announce your 25 intentions, and name it XXX-something where XXX is the number of the issue. 26 27 Submit unit tests for your changes. Go has a great test framework built in; use 28 it! Take a look at existing tests for inspiration. Run the full test suite on 29 your branch before submitting a pull request. 30 31 Update the documentation when creating or modifying features. Test 32 your documentation changes for clarity, concision, and correctness, as 33 well as a clean documentation build. See ``docs/README.md`` for more 34 information on building the docs and how docs get released. 35 36 Write clean code. Universally formatted code promotes ease of writing, reading, 37 and maintenance. Always run `gofmt -s -w file.go` on each changed file before 38 committing your changes. Most editors have plugins that do this automatically. 39 40 Pull requests descriptions should be as clear as possible and include a 41 reference to all the issues that they address. 42 43 Pull requests must not contain commits from other users or branches. 44 45 Commit messages must start with a capitalized and short summary (max. 50 46 chars) written in the imperative, followed by an optional, more detailed 47 explanatory text which is separated from the summary by an empty line. 48 49 Code review comments may be added to your pull request. Discuss, then make the 50 suggested modifications and push additional commits to your feature branch. Be 51 sure to post a comment after pushing. The new commits will show up in the pull 52 request automatically, but the reviewers will not be notified unless you 53 comment. 54 55 Before the pull request is merged, make sure that you squash your commits into 56 logical units of work using `git rebase -i` and `git push -f`. After every 57 commit the test suite should be passing. Include documentation changes in the 58 same commit so that a revert would remove all traces of the feature or fix. 59 60 Commits that fix or close an issue should include a reference like `Closes #XXX` 61 or `Fixes #XXX`, which will automatically close the issue when merged. 62 63 ### Sign your work 64 65 The sign-off is a simple line at the end of the explanation for the 66 patch, which certifies that you wrote it or otherwise have the right to 67 pass it on as an open-source patch. The rules are pretty simple: if you 68 can certify the below (from 69 [developercertificate.org](http://developercertificate.org/)): 70 71 ``` 72 Developer Certificate of Origin 73 Version 1.1 74 75 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 76 660 York Street, Suite 102, 77 San Francisco, CA 94110 USA 78 79 Everyone is permitted to copy and distribute verbatim copies of this 80 license document, but changing it is not allowed. 81 82 83 Developer's Certificate of Origin 1.1 84 85 By making a contribution to this project, I certify that: 86 87 (a) The contribution was created in whole or in part by me and I 88 have the right to submit it under the open source license 89 indicated in the file; or 90 91 (b) The contribution is based upon previous work that, to the best 92 of my knowledge, is covered under an appropriate open source 93 license and I have the right under that license to submit that 94 work with modifications, whether created in whole or in part 95 by me, under the same open source license (unless I am 96 permitted to submit under a different license), as indicated 97 in the file; or 98 99 (c) The contribution was provided directly to me by some other 100 person who certified (a), (b) or (c) and I have not modified 101 it. 102 103 (d) I understand and agree that this project and the contribution 104 are public and that a record of the contribution (including all 105 personal information I submit with it, including my sign-off) is 106 maintained indefinitely and may be redistributed consistent with 107 this project or the open source license(s) involved. 108 ``` 109 110 then you just add a line to every git commit message: 111 112 Signed-off-by: Joe Smith <joe@gmail.com> 113 114 using your real name (sorry, no pseudonyms or anonymous contributions.) 115 116 You can add the sign off when creating the git commit via `git commit -s`.