diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 46 |
1 files changed, 21 insertions, 25 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc416537ab..b2f9ece975 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ We utilize **Github Issues** for issue tracking and contributions. You can contr We have a 3 step process that utilizes **Github Issues**: -1. Sign or be added to an existing [Contributor License Agreement (CLA)](https://supermarket.getchef.com/become-a-contributor). +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. 3. Do [Code Review](#cr) with the **Chef Engineering Team** or **Chef Core Committers** on the pull request. @@ -21,7 +21,7 @@ Chef is built to last. We strive to ensure high quality throughout the Chef expe this, we require a couple of things for all pull requests to Chef: 1. **Tests:** To ensure high quality code and protect against future regressions, we require all the - code in Chef to have at least unit test coverage. See the [spec/unit](https://github.com/opscode/chef/tree/master/spec/unit) + code in Chef to have at least unit test coverage. See the [spec/unit](https://github.com/chef/chef/tree/master/spec/unit) directory for the existing tests and use ```bundle exec rake spec``` to run them. 2. **Green Travis Run:** We use [Travis CI](https://travis-ci.org/) in order to run our tests continuously on all the pull requests. We require the Travis runs to succeed on every pull @@ -63,14 +63,14 @@ You can watch the recordings of the old Code Review hangouts on the [opscodebtm] 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/opscode/chef/blob/master/LICENSE) +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, - most often when the contributor is doing work for a company. + such as when the contributor is doing work for 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 @@ -81,10 +81,10 @@ To make a good faith effort to ensure these criteria are met, Chef requires an I It only takes a few minutes to complete a CLA, and you retain the copyright to your contribution. You can complete our - [Individual CLA](https://supermarket.getchef.com/icla-signatures/new) online. + [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.getchef.com/ccla-signatures/new) instead. + [Corporate CLA](https://supermarket.chef.io/ccla-signatures/new) instead. ### Chef Obvious Fix Policy @@ -109,7 +109,7 @@ As a rule of thumb, changes are obvious fixes if they do not introduce any new f ``` ------------------------------------------------------------------------ commit 370adb3f82d55d912b0cf9c1d1e99b132a8ed3b5 -Author: danielsdeleo <dan@opscode.com> +Author: danielsdeleo <dan@chef.io> Date: Wed Sep 18 11:44:40 2013 -0700 Fix typo in config file docs. @@ -126,16 +126,16 @@ Chef Issue Tracking is handled using Github Issues. If you are familiar with Chef and know the component that is causing you a problem or if you have a feature request on a specific component you can file an issue in the corresponding Github project. All of our Open Source Software can be found in our - [Github organization](https://github.com/opscode/). + [Github organization](https://github.com/chef/). There is also a listing of the various Chef products and where to file issues that can be found in the Chef docs in the [community contributions section](https://docs.chef.io/community_contributions.html#issues-and-bug-reports). -Otherwise you can file your issue in the [Chef project](https://github.com/opscode/chef/issues) +Otherwise you can file your issue in the [Chef project](https://github.com/chef/chef/issues) and we will make sure it gets filed against the appropriate project. -In order to decrease the back and forth an issues and help us get to the bottom of them quickly - we use below issue template. You can copy paste this code into the issue you are opening and +In order to decrease the back and forth in issues, and to help us get to the bottom of them quickly + we use the below issue template. You can copy/paste this template into the issue you are opening and edit it accordingly. <a name="issuetemplate"></a> @@ -148,33 +148,29 @@ In order to decrease the back and forth an issues and help us get to the bottom ### Scenario: [What you are trying to achieve and you can't?] - - ### Steps to Reproduce: [If you are filing an issue what are the things we need to do in order to repro your problem?] - ### Expected Result: [What are you expecting to happen as the consequence of above reproduction steps?] - ### Actual Result: [What actually happens after the reproduction steps?] ``` ### Useful Github Queries -Contributions go through a review process to improve code quality and avoid regressions. Managing a large number of contributions requires a workflow to provide queues for work such as triage, code review, and merging. A semi-formal process has evolved over the life of the project. Chef maintains this process pending community development and acceptance of an [RFC](https://github.com/opscode/chef-rfc). These queries will help track contributions through this process: +Contributions go through a review process to improve code quality and avoid regressions. Managing a large number of contributions requires a workflow to provide queues for work such as triage, code review, and merging. A semi-formal process has evolved over the life of the project. Chef maintains this process pending community development and acceptance of an [RFC](https://github.com/chef/chef-rfc). These queries will help track contributions through this process: -* [Issues that are not assigned to a team](https://github.com/opscode/chef/issues?q=is%3Aopen+-label%3AAIX+-label%3ABSD+-label%3Awindows+-label%3A%22Chef+Core%22++-label%3A%22Dev+Tools%22+-label%3AUbuntu+-label%3A%22Enterprise+Linux%22+-label%3A%22Ready+For+Merge%22+-label%3AMac+-label%3ASolaris+) -* [Untriaged Issues](https://github.com/opscode/chef/issues?q=is%3Aopen+is%3Aissue+-label%3ABug+-label%3AEnhancement+-label%3A%22Tech+Cleanup%22+-label%3A%22Ready+For+Merge%22) -* [PRs to be Reviewed](https://github.com/opscode/chef/labels/Pending%20Maintainer%20Review) -* [Suitable for First Contribution](https://github.com/opscode/chef/labels/Easy) +* [Issues that are not assigned to a team](https://github.com/chef/chef/issues?q=is%3Aopen+-label%3AAIX+-label%3ABSD+-label%3Awindows+-label%3A%22Chef+Core%22++-label%3A%22Dev+Tools%22+-label%3AUbuntu+-label%3A%22Enterprise+Linux%22+-label%3A%22Ready+For+Merge%22+-label%3AMac+-label%3ASolaris+) +* [Untriaged Issues](https://github.com/chef/chef/issues?q=is%3Aopen+is%3Aissue+-label%3ABug+-label%3AEnhancement+-label%3A%22Tech+Cleanup%22+-label%3A%22Ready+For+Merge%22) +* [PRs to be Reviewed](https://github.com/chef/chef/labels/Pending%20Maintainer%20Review) +* [Suitable for First Contribution](https://github.com/chef/chef/labels/Easy) ## <a name="release"></a> Chef Release Cycles Our primary shipping vehicle is operating system specific packages that includes - all the requirements of Chef. We call these [Omnibus packages](https://github.com/opscode/omnibus-ruby) + all the requirements of Chef. We call these [Omnibus packages](https://github.com/chef/omnibus) We also release our software as gems to [Rubygems](https://rubygems.org/) but we strongly recommend using Chef packages since they are the only combination of native libraries & @@ -194,7 +190,7 @@ We frequently make `alpha` and `beta` releases with version numbers that look li We do a `Minor` release approximately every 3 months and `Patch` releases on a when-needed basis for regressions, significant bugs, and security issues. -Announcements of releases are available on [Chef Blog](http://www.getchef.com/blog) when they are +Announcements of releases are available on [Chef Blog](http://www.chef.io/blog) when they are available. ## Chef Community @@ -207,6 +203,6 @@ Chef is made possible by a strong community of developers and system administrat Also here are some additional pointers to some awesome Chef content: -* [Chef Docs](http://docs.opscode.com/) -* [Learn Chef](https://learnchef.opscode.com/) -* [Chef Inc](http://www.getchef.com/) +* [Chef Docs](https://docs.chef.io/) +* [Learn Chef](https://learn.chef.io/) +* [Chef Inc](https://www.chef.io/) |