From 7182319887e2fb2ca35c57f98e5f2f3e21ea7531 Mon Sep 17 00:00:00 2001
From: Sheng Zha <zhasheng@amazon.com>
Date: Sun, 20 Oct 2019 21:55:55 -0700
Subject: [PATCH] split issue templates

---
 .github/ISSUE_TEMPLATE.md                 | 52 -----------------------
 .github/ISSUE_TEMPLATE/bug_report.md      | 36 ++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 17 ++++++++
 .github/ISSUE_TEMPLATE/flaky_test.md      | 18 ++++++++
 4 files changed, 71 insertions(+), 52 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/ISSUE_TEMPLATE/flaky_test.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index 5279dd24a716..000000000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,52 +0,0 @@
-Note: Providing complete information in the most concise form is the best way to get help. This issue template serves as the checklist for essential information to most of the technical issues and bug reports. For non-technical issues and feature requests, feel free to present the information in what you believe is the best form.
-
-For Q & A and discussion, please start a discussion thread at https://discuss.mxnet.io 
-
-## Description
-(Brief description of the problem in no more than 2 sentences.)
-
-## Environment info (Required)
-
-```
-What to do:
-1. Download the diagnosis script from https://raw.githubusercontent.com/apache/incubator-mxnet/master/tools/diagnose.py
-2. Run the script using `python diagnose.py` and paste its output here.
-
-```
-
-Package used (Python/R/Scala/Julia):
-(I'm using ...)
-
-For Scala user, please provide:
-1. Java version: (`java -version`)
-2. Maven version: (`mvn -version`)
-3. Scala runtime if applicable: (`scala -version`)
-
-For R user, please provide R `sessionInfo()`:
-
-## Build info (Required if built from source)
-
-Compiler (gcc/clang/mingw/visual studio):
-
-MXNet commit hash:
-(Paste the output of `git rev-parse HEAD` here.)
-
-Build config:
-(Paste the content of config.mk, or the build command.)
-
-## Error Message:
-(Paste the complete error message, including stack trace.)
-
-## Minimum reproducible example
-(If you are using your own code, please provide a short script that reproduces the error. Otherwise, please provide link to the existing example.)
-
-## Steps to reproduce
-(Paste the commands you ran that produced the error.)
-
-1.
-2.
-
-## What have you tried to solve it?
-
-1.
-2.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000000..4540f8f5f7af
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'Bug'
+assignees: ''
+
+---
+## Description
+(A clear and concise description of what the bug is.)
+
+### Error Message
+(Paste the complete error message, including stack trace.)
+
+## To Reproduce
+(If you developed your own code, please provide a short script that reproduces the error. For existing examples, please provide link.)
+
+### Steps to reproduce
+(Paste the commands you ran that produced the error.)
+
+1.
+2.
+
+## What have you tried to solve it?
+
+1.
+2.
+
+## Environment
+
+We recommend using our script for collecting the diagnositc information. Run the following command and paste the outputs below:
+```
+curl --retry 10 -s https://raw.githubusercontent.com/dmlc/gluon-nlp/master/tools/diagnose.py | python
+
+# paste outputs here
+```
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000000..777f7b7ad400
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'Feature request'
+assignees: ''
+
+---
+
+## Description
+(A clear and concise description of what the feature is.)
+- If the proposal is about a new model, provide description of what the model is.
+- If the proposal is about an API, provide mock examples if possible.
+
+## References
+- list reference and related literature
+- list known implementations
diff --git a/.github/ISSUE_TEMPLATE/flaky_test.md b/.github/ISSUE_TEMPLATE/flaky_test.md
new file mode 100644
index 000000000000..9e01ea1af564
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/flaky_test.md
@@ -0,0 +1,18 @@
+---
+name: Flaky test
+about: Report a flaky test
+title: ''
+labels: 'Flaky'
+assignees: ''
+
+---
+## Description
+(The location and name of the flaky test.)
+
+## Occurrences
+(Links to the known occurrences.)
+
+## What have you tried to solve it?
+
+1.
+2.