From 2fb15316535731b17df78d98c60a83e9d72730b6 Mon Sep 17 00:00:00 2001
From: Kai Chen <chenkaidev@gmail.com>
Date: Wed, 3 Jul 2019 00:50:22 +0800
Subject: [PATCH] Update issue templates (#917)
* Update issue templates
* remove bug_report.md
* Update error-report.md
---
.../{bug_report.md => error-report.md} | 27 +++++++++----------
1 file changed, 13 insertions(+), 14 deletions(-)
rename .github/ISSUE_TEMPLATE/{bug_report.md => error-report.md} (63%)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/error-report.md
similarity index 63%
rename from .github/ISSUE_TEMPLATE/bug_report.md
rename to .github/ISSUE_TEMPLATE/error-report.md
index 521997b..a5020bc 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/error-report.md
@@ -1,5 +1,5 @@
---
-name: Bug report
+name: Error report
about: Create a report to help us improve
title: ''
labels: ''
@@ -7,29 +7,22 @@ assignees: ''
---
-Thanks for your bug report and we appreciate that a lot.
+Thanks for your error report and we appreciate it a lot.
**Checklist**
-- [ ] I have searched related issues but could not get the expected help.
-- [ ] The bug has not been fixed in the latest version.
+1. I have searched related issues but cannot get the expected help.
+2. The bug has not been fixed in the latest version.
**Describe the bug**
A clear and concise description of what the bug is.
-If there are any related issues or upstream bugs, please also refer to them.
-**Error traceback**
+**Reproduction**
1. What command or script did you run?
```
A placeholder for the command.
```
-2. If applicable, paste the error trackback here using code blocks.
-```
-A placeholder for trackback.
-```
-
-**Reproduction details**
-1. Did you make any modifications on the code? Did you understand what you have modified?
-2. What dataset did you use?
+2. Did you make any modifications on the code or config? Did you understand what you have modified?
+3. What dataset did you use?
**Environment**
- OS: [e.g., Ubuntu 16.04.6]
@@ -40,5 +33,11 @@ A placeholder for trackback.
- CUDA and CUDNN version
- [optional] Other information that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
+**Error traceback**
+If applicable, paste the error trackback here.
+```
+A placeholder for trackback.
+```
+
**Bug fix**
If you have already identified the reason, you can provide the information here. If you are willing to create a PR to fix it, please also leave a comment here and that would be much appreciated!
--
GitLab