From db26e5fa02c0824d37f010556bfd108379d05b26 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Fri, 20 May 2016 11:44:02 -0700 Subject: Update contributing doc to better reflect reality Point to the new mailing list Remove the issue template since that's handled automatically now Remove office hours since we're not doing that anymore https a few more URLs --- .github/ISSUE_TEMPLATE.md | 35 +++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 41 +++-------------------------------------- ISSUE_TEMPLATE.md | 35 ----------------------------------- 3 files changed, 38 insertions(+), 73 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md delete mode 100644 ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..562e43e797 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,35 @@ +## Description + +Briefly describe the issue + +## Chef Version + +Tell us which version of chef-client you are using (see below for Server+ChefDK bugs). + +## Platform Version + +Tell us which Operating System distribution and version chef-client is running on. + +## Replication Case + +Tell us what steps to take to replicate your problem. See [How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve) +for information on how to create a good replication case. + +## Client Output + +The relevant output of the chef-client run or a link to a gist of the entire run, if there is one. + +The debug output (chef-client -l debug) may be useful, but please link to a gist, or truncate it. + +## Stacktrace + +Please include the stacktrace.out output or link to a gist of it, if there is one. + +### NOTE: CHEF CLIENT BUGS ONLY + +This issue tracker is for the code contained within this repo -- `chef-client`, base `knife` functionality (not +plugins), `chef-apply`, `chef-solo`, `chef-client -z`, etc. + +* [Server issues](https://github.com/chef/chef-server/issues/new) +* [ChefDK issues](https://github.com/chef/chef-dk/issues/new) +* Cookbook Issues (see the https://github.com/chef-cookbooks repos or search [Supermarket](https://supermarket.chef.io) or GitHub/Google) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b2f9ece975..23dd85d7b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,9 +27,6 @@ Chef is built to last. We strive to ensure high quality throughout the Chef expe 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 - of the pull request. ### Chef Code Review Process @@ -49,15 +46,6 @@ Once you a pull request, the **Chef Engineering Team** or **Chef Core Committers 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). -### Developer Office Hours - -We hold regular "office hours" on Google Hangouts On-The-Air that you can join to review contributions together, -ask questions about contributing, or just hang out with Chef Software employees. The regularly scheduled Chef hangouts occur on Mondays and Wednesdays at 3pm Eastern / Noon Pacific. - -The link to join the Hangout or watch it live is usually tweeted from [@ChefOfficeHours](https://twitter.com/ChefOfficeHours) -and posted in the #chef IRC channel on irc.freenode.net when the hangout is about to start. - -You can watch the recordings of the old Code Review hangouts on the [opscodebtm](http://www.youtube.com/opscodebtm) youtube account. ### Contributor License Agreement (CLA) Licensing is very important to open source projects. It helps ensure the @@ -134,29 +122,6 @@ There is also a listing of the various Chef products and where to file issues th 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 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. - - -``` -### Version: -[Version of the project installed] - -### Environment: [Details about the environment such as the Operating System, cookbook details, etc...] - -### 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 @@ -190,7 +155,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.chef.io/blog) when they are +Announcements of releases are available on [Chef Blog](https://www.chef.io/blog/) when they are available. ## Chef Community @@ -198,8 +163,8 @@ Announcements of releases are available on [Chef Blog](http://www.chef.io/blog) 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: -* [chef](http://lists.opscode.com/sympa/info/chef) and [chef-dev](http://lists.opscode.com/sympa/info/chef-dev) mailing lists -* [\#chef](https://botbot.me/freenode/chef) and [\#chef-hacking](https://botbot.me/freenode/chef-hacking) IRC channels on irc.freenode.net +* [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: diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 562e43e797..0000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,35 +0,0 @@ -## Description - -Briefly describe the issue - -## Chef Version - -Tell us which version of chef-client you are using (see below for Server+ChefDK bugs). - -## Platform Version - -Tell us which Operating System distribution and version chef-client is running on. - -## Replication Case - -Tell us what steps to take to replicate your problem. See [How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve) -for information on how to create a good replication case. - -## Client Output - -The relevant output of the chef-client run or a link to a gist of the entire run, if there is one. - -The debug output (chef-client -l debug) may be useful, but please link to a gist, or truncate it. - -## Stacktrace - -Please include the stacktrace.out output or link to a gist of it, if there is one. - -### NOTE: CHEF CLIENT BUGS ONLY - -This issue tracker is for the code contained within this repo -- `chef-client`, base `knife` functionality (not -plugins), `chef-apply`, `chef-solo`, `chef-client -z`, etc. - -* [Server issues](https://github.com/chef/chef-server/issues/new) -* [ChefDK issues](https://github.com/chef/chef-dk/issues/new) -* Cookbook Issues (see the https://github.com/chef-cookbooks repos or search [Supermarket](https://supermarket.chef.io) or GitHub/Google) -- cgit v1.2.1