diff options
author | Tim Smith <tsmith84@gmail.com> | 2015-11-07 20:33:26 -0800 |
---|---|---|
committer | Tim Smith <tsmith84@gmail.com> | 2015-11-09 09:36:13 -0800 |
commit | 4287cc87b37342b8d8f5a3105872b1026f800064 (patch) | |
tree | 5e81290aead084716e8f7b590623d727a9cc5f37 | |
parent | 8f961b067b907e6bb0c2ca228a3ae6d17fd247ab (diff) | |
download | ohai-4287cc87b37342b8d8f5a3105872b1026f800064.tar.gz |
Ohai-a-tize the contributing doc
It was copied from Chef at one point. Sync up the grammer changes that
were made there and update to Ohai where necessary. There's still many
references to Chef the community and Chef the company, but it makes more
sense when read from the Ohai repo now.
-rw-r--r-- | CONTRIBUTING.md | 79 | ||||
-rw-r--r-- | README.md | 6 |
2 files changed, 42 insertions, 43 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 271d1ee7..59a4acb2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,41 +1,39 @@ -# Contributing to Chef +# Contributing to Ohai -We are glad you want to contribute to Chef! +We are glad you want to contribute to Ohai! We utilize **Github Issues** for issue tracking and contributions. You can contribute in two ways: 1. Reporting an issue or making a feature request [here](#issues). -2. Adding features or fixing bugs yourself and contributing your code to Chef. +2. Adding features or fixing bugs yourself and contributing your code to Ohai. ## Contribution Process We have a 3 step process that utilizes **Github Issues**: -1. Sign our - [Individual Contributor License Agreement (CLA)](https://secure.echosign.com/public/hostedForm?formid=PJIF5694K6L) - or [Corporate CLA](https://secure.echosign.com/public/hostedForm?formid=PIE6C7AX856) online once. +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. -### <a name="pulls"></a> Chef Pull Requests +### <a name="pulls"></a> Ohai Pull Requests -Chef is built to last. We strive to ensure high quality throughout the Chef experience. In order to ensure - this, we require a couple of things for all pull requests to Chef: +Ohai is built to last. We strive to ensure high quality throughout the Ohai experience. In order to ensure + this, we require a couple of things for all pull requests to Ohai: 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 Ohai to have at least unit test coverage. See the [spec/unit](https://github.com/chef/ohai/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 request before being merged. In addition to this it would be nice to include the description of the problem you are solving - with your change. You can use [Chef Issue Template](#issuetemplate) in the description section + with your change. You can use the [Issue Template](#issuetemplate) in the description section of the pull request. -### <a name="cr"></a> Chef Code Review Process +### <a name="cr"></a>Code Review Process -The Chef Code Review process happens on Github pull requests. See +The code review process happens via Github pull requests. See [this article](https://help.github.com/articles/using-pull-requests) if you're not familiar with Github Pull Requests. @@ -48,21 +46,21 @@ Once you a pull request, the **Chef Engineering Team** or **Chef Core Committers and you will be included in `CHANGELOG.md`. Our goal is to have patches merged in 2 weeks after they are marked to be merged. -If you would like to learn about when your code will be available in a release of Chef, read more about - [Chef Release Process](#release). +If you would like to learn about when your code will be available in a release of Ohai, read more about + the [Release Process](#release). ### Contributor License Agreement (CLA) 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/ohai/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 @@ -73,10 +71,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://secure.echosign.com/public/hostedForm?formid=PJIF5694K6L) 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://secure.echosign.com/public/hostedForm?formid=PIE6C7AX856) instead. + [Corporate CLA](https://supermarket.chef.io/ccla-signatures/new) instead. ### Chef Obvious Fix Policy @@ -111,20 +109,20 @@ Date: Wed Sep 18 11:44:40 2013 -0700 ------------------------------------------------------------------------ ``` -## <a name="issues"></a> Chef Issue Tracking +## <a name="issues"></a> Ohai Issue Tracking -Chef Issue Tracking is handled using Github Issues. +Ohai 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 +If you are familiar with Ohai 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/). -Otherwise you can file your issue in the [Chef project](https://github.com/opscode/chef/issues) +Otherwise you can file your issue in the [Ohai project](https://github.com/chef/ohai/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> @@ -132,7 +130,7 @@ In order to decrease the back and forth an issues and help us get to the bottom ### Version: [Version of the project installed] -### Environment: [Details about the environment such as the Operating System, cookbook details, etc...] +### Environment: [Details about the environment such as the Operating System, cloud provider, etc...] ### Scenario: [What you are trying to achieve and you can't?] @@ -151,14 +149,14 @@ In order to decrease the back and forth an issues and help us get to the bottom [What actually happens after the reproduction steps?] ``` -## <a name="release"></a> Chef Release Cycles +## <a name="release"></a>Ohai 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 and Ohai. We call these [Omnibus packages](https://github.com/chef/omnibus) -We also release our software as gems to [Rubygems](http://rubygems.org/) but we strongly - recommend using Chef packages since they are the only combination of native libraries & - gems required by Chef that we test throughly. +We also release our software as gems to [Rubygems](https://rubygems.org/) but we strongly + recommend using the Chef packages, since they are the only combination of native libraries + and gems required by Ohai that we test throughly. Our version numbering closely follows [Semantic Versioning](http://semver.org/) standard. Our standard version numbers look like X.Y.Z which mean: @@ -174,19 +172,20 @@ 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.chef.io/blog) when they are - available. +Announcements of releases are available on [Chef Blog](https://www.chef.io/blog/) at the + time of release ## Chef Community -Chef is made possible by a strong community of developers and system administrators. If you have - any questions or if you would like to get involved in the Chef community you can check out: +Ohai is made possible by a strong community of developers and system administrators in the Chef + community. If you have any questions or if you would like to get involved in the community you + can check out: -* [chef](http://lists.opscode.com/sympa/info/chef) and [chef-dev](http://lists.opscode.com/sympa/info/chef-dev) mailing lists +* [chef](https://discourse.chef.io/) mailing list * [\#chef](https://botbot.me/freenode/chef) and [\#chef-hacking](https://botbot.me/freenode/chef-hacking) IRC channels on irc.freenode.net Also here are some additional pointers to some awesome Chef content: -* [Chef Docs](http://docs.chef.io/) -* [Learn Chef](https://learnchef.chef.io/) -* [Chef Inc](http://www.chef.io/) +* [Chef Docs](https://docs.chef.io/) +* [Learn Chef](https://learn.chef.io/) +* [Chef Inc](https://www.chef.io/) @@ -16,8 +16,8 @@ Chef distributes ohai as a RubyGem. This README is for developers who want to modify the Ohai source code. For users who want to write plugins for Ohai, see the docs: -* General documentation: http://docs.chef.io/ohai.html -* Custom plugin documentation: http://docs.chef.io/ohai_custom.html +* General documentation: https://docs.chef.io/ohai.html +* Custom plugin documentation: https://docs.chef.io/ohai_custom.html # DEVELOPMENT: @@ -67,7 +67,7 @@ Ohai has some Rake tasks for doing various things. Source: -* http://github.com/chef/ohai/tree/master +* https://github.com/chef/ohai/tree/master Issues: |