From 3bec577f93fb5d57b20a7c69184116f6ade6c92e Mon Sep 17 00:00:00 2001 From: Chris Sewell Date: Thu, 14 Feb 2019 12:23:28 +0000 Subject: [PATCH] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 42 +++++++++++++++++----------- 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ac76e2d..4a902d7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,11 +6,14 @@ labels: bug assignees: '' --- +# Bug Report + +## Describe the bug -**Describe the bug** A clear and concise description of what the bug is. -**To Reproduce** +## To Reproduce + Steps to reproduce the behavior: 1. step 1 @@ -18,27 +21,34 @@ Steps to reproduce the behavior: (for extended explanation, use the additional context section) -**Minimal Notebook Example** +## Minimal Notebook Example + If possible, please create a minimal Jupyter Notebook to replicate the issue. -Then rename its file extension to `.txt` (since Github rejects .ipynb), +Then rename its file extension to `.txt` (since Github rejects .ipynb), and drag and drop it here. -**Expected behavior** +## Expected Behaviour + A clear and concise description of what you expected to happen. -**Runtime Information (please complete the following information):** - - IPyPublish [e.g. 0.8.3]: - - Python: [e.g. 3.6.1] - - OS: [e.g. OSX 10.5.1] - - Pandoc: [run `pandoc --version`] +## Runtime Information - - (optional for pdf issues) texlive: [run `tex`] - - (optional for pdf issues) latexmk: [run `latexmk --version`] - - - Versions of any other relevant python packages +(please complete the following information) + +- IPyPublish: [e.g. 0.8.3] +- Python: [e.g. 3.6.1] +- OS: [e.g. OSX 10.5.1] +- Pandoc: [run `pandoc --version`] + +- (optional for pdf issues) texlive: [run `tex`] +- (optional for pdf issues) latexmk: [run `latexmk --version`] + +- Versions of any other relevant python packages + +## Additional context -**Additional context** Add any other context about the problem here. -**Logging** +## Logging + Drag and drop the log file here, or copy and paste the output from the terminal