Bug reporting 101
Have you found a bug? Don’t panic, here are some steps to report it with ease:
-
Search for it on the bug tracker (don’t forget to use the search bar).
-
If you find a similar bug, don’t hesitate to post a comment to add more importance to the related ticket.
-
If you didn’t find it, open a new ticket.
If you have to create a new ticket, please try to keep in mind the following advice:
- Check that you can still reproduce the bug on latest release
- Give an explicit title to the ticket so it will be easier to find it later.
- Be as exhaustive as possible in the description: what did you do? What is the bug? What are the steps to reproduce the bug?
Required information
-
KOReader version
-
document rendering issue? : attach a sample document that shows the bug.
- You can attach the document as is if it is not copyrighted.
- You can attach a scrambled copy of the document (only for epub)
- Extra points if you create a minimum test case that shows the bug and nothing else.
If you have a document that's copyrighted, is not an epub and you don't want to share with us privately you'll need to provide a test case.
-
other issue?: attach the
crash.log-
Android: Go to
Help→Bug Reportto dump logs to file. -
Desktop: Run from a terminal emulator and capture the output (ie:
koreader | tee crash.logorkoreader >crash.log 2>&1) -
Embedded:
Platform Method File Cervantes SSH2 /mnt/private/koreader/crash.logKindle USB1 koreader/crash.logKobo USB1 .adds/koreader/crash.logPocketbook USB1 applications/koreader/crash.logRemarkable SSH2 /opt/koreader/crash.log1 Connect to computer as an USB share and copy that file.
2 Use
scpy(or similar Windows app?) to get the log (ie:scpy root@ip:/path/to/crash.log crash.log)
-
Credits
Part of this text is a verbatim copy of https://freshrss.github.io/FreshRSS/en/contributing.html. Thanks!