From 179b106e9ee3497856c4d487e40839811e8225c0 Mon Sep 17 00:00:00 2001 From: Vedang Manerikar Date: Fri, 2 Dec 2022 13:37:53 +0530 Subject: 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. --- .github/ISSUE_TEMPLATE/bug_report.md | 18 ++++++++++-------- README.org | 37 ++++++++++++++++++++++++++++++++++++ TODO.org | 22 ++++++++++++--------- 3 files changed, 60 insertions(+), 17 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. diff --git a/README.org b/README.org index 09ed930..c4306b9 100644 --- a/README.org +++ b/README.org @@ -497,6 +497,43 @@ The ~server/test/docker~ folder contains Dockerfile templates used for testing t To see the list of operating systems where compilation testing is supported, run ~make server-test-supported~. To see the list of operating systems where testing is unsupported, run ~make server-test-unsupported~. To add support, look into the ~server/test/docker/templates~ folder (~ubuntu~ files are a good example to refer to) +** Issue Template for Bug Reports +:PROPERTIES: +:CREATED: [2022-12-02 Fri 13:30] +:ID: F563A2A4-FCF8-4F04-94CA-19E80E4841A6 +:END: +Please use the 'Bug Report' issue template when reporting bugs. The template is as follows: + +*** Describe the bug +A clear and concise description of what the bug is. + +*** Steps To Reproduce the behaviour: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +*** What is the expected behaviour? +A clear and concise description of what you expected to happen. + +*** 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] + +*** 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 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. + * FAQs :PROPERTIES: :CREATED: [2021-12-30 Thu 22:04] diff --git a/TODO.org b/TODO.org index 71384eb..58b9988 100644 --- a/TODO.org +++ b/TODO.org @@ -1,21 +1,25 @@ #+TITLE: A list of important / desirable tasks * pdf-isearch -** Allow for entering multi-byte characters with some input-methods. +** TODO Allow for entering multi-byte characters with some input-methods. The PDF buffer is in uni-byte mode. It prohibits the user from inserting multi-byte characters in the minibuffer with some input-methods, while editing the search string. * pdf-forms +** TODO Add support for editing forms Recent poppler versions have some support for editing forms. * pdf-annot -** Updating the list buffer is too slow +** TODO Add support for free-text annotations +** TODO Updating the annot list buffer is too slow + Update it incrementally. + Possibly skip the update if the buffer is not visible. -** Make highlighting customizable * epdfinfo -** Maybe split the code up in several files. +** TODO Maybe split the code up in several files. * pdf-view -** Provide some kind of multi-page view -** Make persistent scrolling relative -Currently the scrolling is kept when changing the image's size (in pdf-view-display-image), which is actually not so desirable, since it is absolute. This results e.g. in the image popping out of the window, when it is shrunken. +** TODO Provide some kind of multi-page view +** TODO Make persistent scrolling relative +Currently the scrolling is kept when changing the image's size (in ~pdf-view-display-image~), which is actually not so desirable, since it is absolute. This results e.g. in the image popping out of the window, when it is shrunken. * pdf-info -** Add a report/debug command, displaying a list of open files and other information. -** Use alists for results instead of positional lists. +** TODO Add a report/debug command +- Display a list of open files +- Display ~pdf-tools~ version as reported by ~package.el~ +- Display custom configuration for ~pdf-tools~ (how?) +** TODO Use alists for results instead of positional lists. -- cgit v1.0