浏览代码

Update bug_report.md

Nick Sweeting 6 年之前
父节点
当前提交
ee3e8d4926
共有 1 个文件被更改,包括 20 次插入20 次删除
  1. 20 20
      .github/ISSUE_TEMPLATE/bug_report.md

+ 20 - 20
.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,26 +7,26 @@ assignees: ''
 
 
 ---
 ---
 
 
-### Describe the bug
+(please fill out the following information, feel free to delete sections if they're not applicable)
+
+## Describe the bug
 A description of what the bug is, what you expected to happen, 
 A description of what the bug is, what you expected to happen, 
 and any relevant context about issue.
 and any relevant context about issue.
 
 
-### Steps to reproduce
-Steps to reproduce the behavior:  
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-### Screenshots or log output
-If applicable, use screenshots or copy/pasted terminal output to help explain your problem.
-
-### Software versions
-(please complete the following information)
-
- - OS: [e.g. macOS 10.14] (the operating system you're running ArchiveBox on)
- - ArchiveBox version: `git rev-parse HEAD | head -c7` (commit ID of the version you're running)
- - Docker version: `docker --version` [e.g. 18.09.2] (if using Docker)
- - Python version: `python3 --version` [e.g. 3.7.0]
- - Chrome version: `chromium-browser --version` [e.g. 73.1.2.3] (if relevant to bug)
- - Wget version: `wget --version` [e.g. 1.20.1] (if relevant to bug)
+## Steps to reproduce
+
+1. Ran ArchiveBox with the following config '...'
+2. Saw this output during archiving '....'
+3. UI didn't show the thing I was expecting '....'
+
+## Screenshots or log output
+
+If applicable, post any relevant screenshots or copy/pasted terminal output from ArchiveBox.
+If you're reporting a parsing / importing error, **you must paste a copy of your redacted import file here**.
+
+## Software versions
+
+ - OS:                        ([e.g. macOS 10.14] the operating system you're running ArchiveBox on)
+ - ArchiveBox version:        (`git rev-parse HEAD | head -c7` [e.g. d798117] commit ID of the version you're running)
+ - Python version:            (`python3 --version` [e.g. 3.7.0])
+ - Chrome version:            (`chromium-browser --version` [e.g. 73.1.2.3] if relevant to bug)