summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2017-12-11 12:05:32 -0800
committerGitHub <noreply@github.com>2017-12-11 12:05:32 -0800
commita372995ee67cce1bbe32a5e24b43851bdb9427cd (patch)
tree8226a7fc013f1ceae10d003c80823c98facc9904
parent2ed7c7be81b930e99affb139f1854309d55fabb5 (diff)
downloadchef-better_issues.tar.gz
Use comments in the github issue templatebetter_issues
This way we don't see the end users notes when they submit it. This should make it easier to read the issues.
-rw-r--r--.github/ISSUE_TEMPLATE.md47
1 files changed, 24 insertions, 23 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index d6ca06036d..c6f0984993 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,36 +1,37 @@
-## Description
+<!---
+!!!!!! NOTE: CHEF CLIENT BUGS ONLY !!!!!!
-Briefly describe the issue
+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.
-## Chef Version
+* Requests for new or alternative functionality should be made to [feedback.chef.io](https://feedback.chef.io/forums/301644-chef-product-feedback/category/110832-chef-client)
+* [Chef 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)
-Tell us which version of chef-client you are using (see below for Server+ChefDK bugs).
+-->
-## Platform Version
+## Description
+<!--- Briefly describe the issue -->
-Tell us which Operating System distribution and version chef-client is running on.
+## Chef Version
+<!--- Tell us which version of chef-client you are using (see below for Server+ChefDK bugs). -->
-## Replication Case
+## Platform Version
+<!--- Tell us which Operating System distribution and version chef-client is running on. -->
-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.
+## 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 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.
+The debug output (chef-client -l debug) may be useful, but please link to a gist, or truncate it. -->
-### 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.
+```
-* Requests for new or alternative functionality should be made to [feedback.chef.io](https://feedback.chef.io/forums/301644-chef-product-feedback/category/110832-chef-client)
-* [Chef 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)
+## Stacktrace
+<!--- Please include the stacktrace.out output or link to a gist of it, if there is one. -->