Browse Source

Rewrote the github issue template to be shorter and more likely to be read (#24486)

Clinton Gormley 8 years ago
parent
commit
e9547d6a70
1 changed files with 21 additions and 28 deletions
  1. 21 28
      .github/ISSUE_TEMPLATE.md

+ 21 - 28
.github/ISSUE_TEMPLATE.md

@@ -1,33 +1,27 @@
 <!--
 
-**Please read the guidelines below.**
+** Please read the guidelines below. **
 
-If you follow these guidelines, you will help make it more likely that you
-achieve the outcome that you are looking for. If you do not follow the these
-guidelines you are going to waste your time and you are going to waste our
-time.
+Issues that do not follow these guidelines are likely to be closed.
 
--->
+1.  GitHub is reserved for bug reports and feature requests. The best place to
+    ask a general question is at the Elastic [forums](https://discuss.elastic.co).
+    GitHub is not the place for general questions.
 
-<!--
-GitHub is reserved for bug reports and feature requests. The best place to ask
-a general question is at the Elastic [forums](https://discuss.elastic.co). GitHub
-is not the place for general questions.
-
-If you are in fact posting a bug report or a feature request, please include
-one and only one of the below blocks in your new issue. Note that whether
-you're filing a bug report or a feature request, ensure that your submission is
-for an [OS that we support](https://www.elastic.co/support/matrix#show_os). Bug
-reports on an OS that we do not support or feature requests specific to an OS
-that we do not support will be closed. Bug reports that do not follow the below
-template are at risk of being closed.
--->
+2.  Is this bug report or feature request for a supported OS? If not, it
+    is likely to be closed.  See https://www.elastic.co/support/matrix#show_os
+
+3.  Please fill out EITHER the feature request block or the bug report block
+    below, and delete the other block.
 
-<!--
-If you are filing a bug report, please remove the below feature request block
-and provide responses for all of the below items.
 -->
 
+<!-- Feature request -->
+
+**Describe the feature**:
+
+<!-- Bug report -->
+
 **Elasticsearch version**:
 
 **Plugins installed**: []
@@ -39,15 +33,14 @@ and provide responses for all of the below items.
 **Description of the problem including expected versus actual behavior**:
 
 **Steps to reproduce**:
+
+Please include a *minimal* but *complete* recreation of the problem, including
+(e.g.) index creation, mappings, settings, query etc.  The easier you make for
+us to reproduce it, the more likely that somebody will take the time to look at it.
+
  1.
  2.
  3.
 
 **Provide logs (if relevant)**:
 
-<!--
-If you are filing a feature request, please remove the above bug report block
-and provide responses for all of the below items.
--->
-
-**Describe the feature**: