Reporting a bug
Let the app write the report
Section titled “Let the app write the report”- Open More and tap Feedback & Bug Reports.
- Look over the report, then tap Copy Diagnostics.
- Tap Send by Email. An email to [email protected] opens.
- Paste the diagnostics, and add what you were doing.
If you don’t use the Mail app, the address is shown under the button, so you can copy it into any mail app or webmail.
The report is a short summary of your setup: your build, iOS version and device, whether the app’s online, how many changes are waiting to sync, and how many files you’ve downloaded. It classifies your server, for example “signed in (https, Tailscale)”, but never includes its name or address. It also carries the app’s own log lines from the last fifteen minutes, with your server’s host name blanked out.
Nothing’s sent until you paste it somewhere yourself.
File on GitHub on the same screen opens a new issue instead, and Open TestFlight lets TestFlight testers send it with a screenshot.
If it happened while you were reading, TestFlight builds have a round bug button in the reader’s menu. It opens the same report with the book and your position filled in.
Then add the part only you know
Section titled “Then add the part only you know”Please include:
- What you did. Step by step, from opening the app.
- What you expected.
- What happened instead.
- Which book, and what kind: audiobook, EPUB, PDF, comic.
Steps I can follow are worth more than everything else combined. A bug I can repeat is a bug I can fix.
Crashes and things that look wrong
Section titled “Crashes and things that look wrong”Use TestFlight’s Share Beta Feedback. Take a screenshot, shake the phone or open TestFlight, and send it. The screenshot goes with the report, which an email or a GitHub issue can’t do as easily.
Not sure it’s a bug?
Section titled “Not sure it’s a bug?”Start a Q&A discussion. I’ll open an issue if it turns out to be one.
What happens next
Section titled “What happens next”I read every email. For a GitHub issue, I copy the report into my private repo and work on it there. You can’t see that, so I label the issue too: tracked when I’ve picked it up, needs-info if I’m stuck without more from you.
When the fix reaches TestFlight I’ll tell you the build number, by email or on the issue. Update, try it, and tell me if it’s still there.