diff options
| author | mmzyk <mmzyk@opscode.com> | 2015-01-22 11:13:04 -0500 |
|---|---|---|
| committer | mmzyk <mmzyk@opscode.com> | 2015-01-22 11:13:04 -0500 |
| commit | 92c1b12eb079793d7ddff1fbca30565b05b7475b (patch) | |
| tree | 1ce627366beb8398843e7ce058d965957931e87e | |
| parent | 23839c0ad79c600dabbc1149061b230eada2586a (diff) | |
| download | chef-92c1b12eb079793d7ddff1fbca30565b05b7475b.tar.gz | |
Clarify where issues should be filed
This should help people figure out the appropriate place to open
an issue so they don't have to experience opening an issue to only have
it be closed and then told to reopen it somewhere else.
| -rw-r--r-- | CONTRIBUTING.md | 3 | ||||
| -rw-r--r-- | README.md | 13 |
2 files changed, 16 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c19e1011a..cc416537ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -128,6 +128,9 @@ If you are familiar with Chef and know the component that is causing you a probl Github project. All of our Open Source Software can be found in our [Github organization](https://github.com/opscode/). +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) and we will make sure it gets filed against the appropriate project. @@ -76,6 +76,19 @@ TDD with RSpec, so you'll need to get a development environment running. Follow the above procedure ("Installing from Git") to get your local copy of the source running. +## Reporting Issues + +Issues can be reported by using [GitHub issues](https://github.com/opscode/chef/issues). + +Full details on how to report issues can be found in the [CONTRIBUTING](https://github.com/opscode/chef/blob/master/CONTRIBUTING.md#-chef-issue-tracking) doc. + +Note that this repository is primarily for reporting chef-client issues. +For reporting issues against other Chef projects, please look up the appropriate repository +to report issues against in the Chef docs in the +[community contributions section](https://docs.chef.io/community_contributions.html#issues-and-bug-reports). +If you can't detemine the appropriate place to report an issue, then please open it +against the repository you think best fits and it will be directed to the appropriate project. + ## Testing We use RSpec for unit/spec tests. It is not necessary to start the development |