diff options
| author | Vedang Manerikar <ved.manerikar@gmail.com> | 2022-12-02 13:37:53 +0530 |
|---|---|---|
| committer | Vedang Manerikar <ved.manerikar@gmail.com> | 2022-12-02 13:42:47 +0530 |
| commit | 179b106e9ee3497856c4d487e40839811e8225c0 (patch) | |
| tree | 9330b1bd91af66e4d34e2429d0211e4149820096 /.github | |
| parent | e51a226464fd98fd22bcd4135fab5c65345465c2 (diff) | |
Add bug report issue template details to the README
This lets me push the template to the wiki as well, which I think is
useful.
Also, note down tasks to help improving reporting in the TODO file.
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 18d617b..49a524a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,29 +10,31 @@ assignees: '' **Describe the bug** A clear and concise description of what the bug is. -**To Reproduce** -Steps to reproduce the behavior: +**Steps to Reproduce the behaviour** +Steps to reproduce the behaviour: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** +**What is the expected behaviour?** A clear and concise description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. +**Desktop** +Please complete the following information: -**Desktop (please complete the following information):** - OS: [eg: MacOS Catalina] - Emacs Version: [This should be the output of `M-x emacs-version`] - Poppler Version: [eg: output of `brew info poppler` and similarly for other OSs] -**pdf-tools (please complete the following information):** +**Your pdf-tools install** +Please complete the following information: + - `pdf-tools` Version: [`M-x package-list-packages` -> Search for `pdf-tools` -> Hit Enter and copy all the details that pop up in the Help buffer] - `pdf-tools` customization / configuration that you use **Additional context** -- If you are reporting a crash, please try and add the Backtrace / Stacktrace of the crash. +- If you are reporting a crash, please try and add the Backtrace / Stacktrace of the crash. - If you are reporting a bug, please try and attach an example PDF file where I can reproduce the bug. +- If you can attach screenshots or recordings, that is a great help - Please try reproducing the bug yourself on Vanilla Emacs before reporting the problem. |