mxnet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From zhash...@apache.org
Subject [incubator-mxnet] branch master updated: update issue template (#8082)
Date Wed, 11 Oct 2017 04:48:07 GMT
This is an automated email from the ASF dual-hosted git repository.

zhasheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git


The following commit(s) were added to refs/heads/master by this push:
     new 956e79b  update issue template (#8082)
956e79b is described below

commit 956e79b8f37f193f3ca4bcb7bbaf964e190d1992
Author: Sheng Zha <szha@users.noreply.github.com>
AuthorDate: Tue Oct 10 21:48:04 2017 -0700

    update issue template (#8082)
    
    * update issue template
    
    * use diagnose script, and reorganize
    
    * Update ISSUE_TEMPLATE.md
    
    * Update ISSUE_TEMPLATE.md
---
 .github/ISSUE_TEMPLATE.md | 46 ++++++++++++++++++++++++++++------------------
 1 file changed, 28 insertions(+), 18 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 85720e6..c7536d3 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,42 +1,52 @@
-For bugs or installation issues, please provide the following information.
-The more information you provide, the more likely people will be able to help you.
+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.
 
-## Environment info
-Operating System:
+If the issue is non-technical, feel free to present the information in what you believe is
the best form.
 
-Compiler:
+## Description
+(Brief description of the problem in no more than 2 sentences.)
 
-Package used (Python/R/Scala/Julia):
+## 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.
 
-MXNet version:
+```
+
+Package used (Python/R/Scala/Julia):
+(I'm using ...)
 
-Or if installed from source:
+For Scala user, please provide:
+1. Java version: (`java -version`)
+2. Maven version: (`mvn -version`)
+3. Scala runtime if applicable: (`scala -version`)
 
-MXNet commit hash (`git rev-parse HEAD`):
+For R user, please provide R `sessionInfo()`:
 
-If you are using python package, please provide
+## Build info (Required if built from source)
 
-Python version and distribution:
+Compiler (gcc/clang/mingw/visual studio):
 
-If you are using R package, please provide
+MXNet commit hash:
+(Paste the output of `git rev-parse HEAD` here.)
 
-R `sessionInfo()`:
+Build config:
+(Paste the content of config.mk, or the build command.)
 
 ## Error Message:
-Please paste the full error message, including stack trace.
+(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.
+(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
-or if you are running standard examples, please provide the commands you have run that lead
to the error.
+(Paste the commands you ran that produced the error.)
 
 1.
 2.
-3.
 
 ## What have you tried to solve it?
 
 1.
 2.
-3.

-- 
To stop receiving notification emails like this one, please contact
['"commits@mxnet.apache.org" <commits@mxnet.apache.org>'].

Mime
View raw message