About Bug Reporting
Reading Forest has a built-in feature that makes it easy to report bugs from within the app. Reports are reviewed by the development team and used to improve the application.
Opening the Bug Report Form
- Click "Help" in the menu bar
- Click "Report a Bug" from the dropdown menu
- The bug report form will appear
There is currently no keyboard shortcut. Please access it from the menu.
Filling Out the Report Form
Select Bug Type
Choose the type that best describes the problem:
- Display Issue - Layout problems, unreadable text, etc.
- Functional Issue - Buttons not responding, errors appearing, etc.
- Data Issue - Cannot save, data disappearing, etc.
- Other - Issues not covered above
Problem Description
Including the following helps us respond faster:
- What you were trying to do - e.g., "I tried to add a book"
- What happened - e.g., "An error message appeared"
- Expected behavior - e.g., "The book should have been added"
- Steps to reproduce - The sequence of actions that led to the problem
Having a screenshot of the issue helps us understand the situation accurately. The form includes a feature to attach screenshots.
Contact Information (Optional)
Enter your email address if you'd like a response. You can submit the report without it.
Choosing a Send Method
The bug report form offers two ways to send your report.
Send via Server (Recommended)
Sends the report and attached images directly to the development team from the server.
- Attached images are included directly in the email
- Just click the button to complete the submission
- Temporary images on the server are automatically deleted after successful delivery
Send via Email App
Uses your email app (Outlook, Gmail, etc.) to send the report.
- Report content is automatically filled into the email body
- You can review and edit the content before sending
- Attached images are stored on the server, with URLs included in the email
Choose "Send via email app" to review the email content before sending. Neither method includes personal data such as reading log contents.
Automatically Collected Information
The following information is automatically collected when you submit a bug report to help resolve the issue:
- App Version - The version you're currently using
- Browser Information - Browser type and version
- OS Information - Your operating system
- Screen Size - Used to identify display-related issues
- Language Setting - App display language
Personal data such as reading log contents or file names are not collected. Collected information is used only to identify and resolve technical issues.
After Submission
If You Chose "Send via Server"
-
Submission Complete
A confirmation message will appear when the report is sent successfully. Attached images are delivered to the development team via email. -
Fallback on Failure
If the server send fails, you'll be asked "Send via email app instead?" Click "OK" to switch to sending via your email app.
If You Chose "Send via Email App"
-
Email App Opens
Your email app will open with the report content pre-filled in the body. -
Send the Email
Review the content and press the send button in your email app.
What Happens Next
-
Review
The development team will review your report. -
Investigation & Fix
We'll investigate the cause and make fixes as needed. -
Response (if email provided)
We'll contact you at the provided email address with updates or follow-up questions.
Frequently Asked Questions
Q: Should I report minor issues?
Yes, please report any issue, no matter how small. Even minor issues can sometimes lead to discovering significant bugs.
Q: I reported the same issue multiple times by mistake
No problem. Duplicate reports are handled automatically.
Q: When will my reported bug be fixed?
It depends on the severity and complexity of the issue. Critical bugs are prioritized, but we cannot guarantee specific timelines.
Q: Can I request new features too?
For feature requests, please use the Contact Form separately from bug reports.