diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 86 |
1 files changed, 71 insertions, 15 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4bc3d9f7ad..3b102c9818 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,20 +16,20 @@ In addition to Github issues, we also utilize a feedback site that helps our pro We have a 3 step process for contributions: -1. Sign or be added to an existing [Contributor License Agreement (CLA)](https://supermarket.chef.io/become-a-contributor). -2. Create a Github Pull Request for your change. -3. Perform a [Code Review](#cr) with the project maintainers on the pull request. +1. Commit changes to a git branch, making sure to sign those changes for the [Developer Certificate of Origin](#developer-certification-of-origin-dco) +2. Create a Github Pull Request for your change, following the instructions in the pull request template +3. Perform a [Code Review](#code-review-process) with the project maintainers on the pull request. ### Pull Request Requirements Chef Projects are built to last. We strive to ensure high quality throughout the experience. In order to ensure this, we require that all pull requests to Chef projects meet these specifications: 1. **Tests:** To ensure high quality code and protect against future regressions, we require all the code in Chef Projects to have at least unit test coverage. We use [RSpec](http://rspec.info/) for unit testing. -2. **Green CI Tests:** We use [Travis CI](https://travis-ci.org/) and [AppVeyor](https://www.appveyor.com/) CI systems to test all pull requests. We require these test runs to succeed on every pull request before being merged. +2. **Green CI Tests:** We use [Travis CI](https://travis-ci.org/) and/or [AppVeyor](https://www.appveyor.com/) CI systems to test all pull requests. We require these test runs to succeed on every pull request before being merged. ### Code Review Process -Code review takes place in Github pull requests. See [this article](https://help.github.com/articles/using-pull-requests) if you're not familiar with Github Pull Requests. +Code review takes place in Github pull requests. See [this article](https://help.github.com/articles/about-pull-requests/) if you're not familiar with Github Pull Requests. Once you open a pull request, Chef engineers will review your code and respond to your pull request with any feedback they might have. The process at this point is as follows: @@ -37,25 +37,81 @@ Once you open a pull request, Chef engineers will review your code and respond t 2. When ready, your pull request will be tagged with label `Ready For Merge`. 3. Your change will be merged into the project's `master` branch and will be noted in the project's `CHANGELOG.md` at the time of release. -If you would like to learn about when your code will be available in a release of Chef, read more about [Chef Release Cycles](#chef-release-cycles). +If you would like to learn about when your code will be available in a release of Chef, read more about [Chef Release Cycles](#release-cycles). -### Contributor License Agreement (CLA) +### Developer Certification of Origin (DCO) Licensing is very important to open source projects. It helps ensure the software continues to be available under the terms that the author desired. Chef uses [the Apache 2.0 license](https://github.com/chef/chef/blob/master/LICENSE) to strike a balance between open contribution and allowing you to use the software however you would like to. -The license tells you what rights you have that are provided by the copyright holder. It is important that the contributor fully understands what rights they are licensing and agrees to them. Sometimes the copyright holder isn't the contributor, such as when the contributor is doing work for a company. +The license tells you what rights you have that are provided by the copyright holder. It is important that the contributor fully understands what rights they are licensing and agrees to them. Sometimes the copyright holder isn't the contributor, such as when the contributor is doing work on behalf of a company. -To make a good faith effort to ensure these criteria are met, Chef requires an Individual CLA or a Corporate CLA for contributions. This agreement helps ensure you are aware of the terms of the license you are contributing your copyrighted works under, which helps to prevent the inclusion of works in the projects that the contributor does not hold the rights to share. +To make a good faith effort to ensure these criteria are met, Chef requires the Developer Certificate of Origin (DCO) process to be followed. -It only takes a few minutes to complete a CLA, and you retain the copyright to your contribution. +The DCO is an attestation attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a Signed-off-by statement and thereby agrees to the DCO, which you can find below or at <http://developercertificate.org/>. -You can complete our [Individual CLA](https://supermarket.chef.io/icla-signatures/new) online. If you're contributing on behalf of your employer and they retain the copyright for your works, have your employer fill out our [Corporate CLA](https://supermarket.chef.io/ccla-signatures/new) instead. +``` +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the + best of my knowledge, is covered under an appropriate open + source license and I have the right under that license to + submit that work with modifications, whether created in whole + or in part by me, under the same open source license (unless + I am permitted to submit under a different license), as + Indicated in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including + all personal information I submit with it, including my + sign-off) is maintained indefinitely and may be redistributed + consistent with this project or the open source license(s) + involved. +``` + +Subsequent developers who co-author or otherwise help shepherd the contribution in some way also add their own attestation so it's not unusual to end up with a contribution which looks like: + +``` + Author: Nathen Harvey <nharvey@chef.io> + + Committer: Adam Jacob <adam@chef.io> + + Sprinkle extra delight on our DSL + + Due to an oversight, we were only 96% delightful. Ensure the + delight now goes to 11. + + Signed-off-by: Nathen Harvey <nharvey@chef.io> + Signed-off-by: Julia Cook <julia@ourcompany.com> + Signed-off-by: Adam Jacob <adam@chef.io> +``` + +For more information on the change see the Chef Blog post [Introducing Developer Certificate of Origin](https://blog.chef.io/2016/09/19/introducing-developer-certificate-of-origin/) + +#### DCO Sign-Off Methods + +The DCO requires a sign-off message in the following format appear on each commit in the pull request + +``` +Signed-off-by: Joe Smith <joe.smith@email.com> +``` + +The DCO text can either be manually added to your commit body, or you can add either **-s** or **--signoff** to your usual git commit commands. If you forget to add the sign-off you can also amend a previous commit with the sign-off by running **git commit –amend -s** ### Chef Obvious Fix Policy -Small contributions, such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted without a CLA. +Small contributions, such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted without signing the contribution for the DCO. As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. Assuming the change does not affect functionality, some common obvious fix examples include the following: @@ -72,10 +128,10 @@ As a rule of thumb, changes are obvious fixes if they do not introduce any new f ``` ------------------------------------------------------------------------ commit 370adb3f82d55d912b0cf9c1d1e99b132a8ed3b5 -Author: danielsdeleo <dan@chef.io> -Date: Wed Sep 18 11:44:40 2013 -0700 +Author: juliachild <julia@chef.io> +Date: Wed Sep 18 11:44:40 2015 -0700 - Fix typo in config file docs. + Fix typo in the README. Obvious fix. |