diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 723c7e0ec8..aa154feb11 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,20 +4,20 @@ We're glad you want to contribute to a Chef project! This document will help ans ## Submitting Issues -Not every contribution comes in the form of code. Submitting, confirming, and triaging issues is an important task for any project. At Chef we use Github to track all project issues. +Not every contribution comes in the form of code. Submitting, confirming, and triaging issues is an important task for any project. At Chef we use GitHub to track all project issues. -If you are familiar with Chef and know the component, that is causing you a problem, 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/chef/). All projects include Github issue templates to help gather information needed for a thorough review. +If you are familiar with Chef and know the component that is causing you a problem, you can file an issue in the corresponding GitHub project. All of our Open Source Software can be found in our [Chef GitHub organization](https://github.com/chef/). All projects include GitHub issue templates to help gather information needed for a thorough review. -We ask you not to submit security concerns via Github. For details on submitting potential security issues please see <https://www.chef.io/security/> +We ask you not to submit security concerns via GitHub. For details on submitting potential security issues please see <https://www.chef.io/security/> -In addition to Github issues, we also utilize a feedback site that helps our product team track and rank feature requests. If you have a feature request, this is an excellent place to start <https://feedback.chef.io> +In addition to GitHub issues, we also utilize a feedback site that helps our product team track and rank feature requests. If you have a feature request, this is an excellent place to start <https://www.chef.io/feedback/> ## Contribution Process We have a 3 step process for contributions: 1. Commit changes to a git branch, making sure to sign-off 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. +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 @@ -29,13 +29,13 @@ Chef Projects are built to last. We strive to ensure high quality throughout the ### Code Review Process -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. +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, project maintainers will review your code and respond to your pull request with any feedback they might have. The process at this point is as follows: 1. Two thumbs-up (:+1:) are required from project maintainers. See the master maintainers document for Chef projects at <https://github.com/chef/chef/blob/master/MAINTAINERS.md>. -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. +2. Your change will be merged into the project's `master` branch +3. Our Expeditor bot will automatically update the project's changelog with your contribution. For projects such as Chef and Chef-DK the version will be automatically incremented and a build kicked off to the project's `current` channel. 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). @@ -90,7 +90,7 @@ The DCO requires a sign-off message in the following format appear on each commi Signed-off-by: Julia Child <juliachild@chef.io> ``` -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**. If you've pushed your changes to Github already you'll need to force push your branch after this with **git push -f**. +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**. If you've pushed your changes to GitHub already you'll need to force push your branch after this with **git push -f**. ### Chef Obvious Fix Policy @@ -123,7 +123,7 @@ Date: Wed Sep 18 11:44:40 2015 -0700 ## 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/chef/omnibus) +Our primary shipping vehicle is operating system specific packages that includes all the requirements of Chef. The packages are built with our [Omnibus](https://github.com/chef/omnibus) packing project. 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 & gems required by Chef that we test throughly. @@ -135,7 +135,7 @@ Our version numbering roughly follows [Semantic Versioning](http://semver.org/) After shipping a release of Chef we bump the `Minor` version by one to start development of the next minor release. All merges to master trigger an increment of the `Patch` version, and a build through our internal testing pipeline. We do a `Minor` release approximately every month, which consist of shipping one of the already auto-incremented and tested `Patch` versions. For example after shiping 12.10.24, we incremented Chef to 12.11.0\. From there 18 commits where merged bringing the version to 12.11.18, which we shipped as an omnibus package. -Announcements of releases are made to the [chef mailing list](https://discourse.chef.io/c/chef-release) when they are available. +Announcements of releases are made to the [chef mailing list](https://discourse.chef.io/c/chef-release) when they are available and are mirrored to the #announcements channel on the [Chef Community Slack](https://community-slack.chef.io/). ## Chef Community @@ -148,4 +148,5 @@ Also here are some additional pointers to some awesome Chef content: - [Chef Docs](https://docs.chef.io/) - [Learn Chef](https://learn.chef.io/) -- [Chef Website](https://www.chef.io/) +- [Chef Software Inc. Website](https://www.chef.io/) +- [Chef Project Website](https://www.chef.sh/) |