A good bug report saves everyone time. Use this checklist before
hitting Submit .
When in doubt, file on the app repo. A maintainer will move it.
Template
** Summary ** : one-line description.
** Expected ** : what should have happened.
** Observed ** : what actually happened.
- App: x.y.z (from Help, About).
- Server: x.y.z (from server log on startup).
- OS: Windows 11 / Ubuntu 24.04 / Android 15.
** Network ** : home Wi-Fi / corporate / mobile.
** Logs ** : attached (redacted), generated with log level = debug.
** Screenshots ** : attached if visual.
Minimum reproduction
Strip down to the smallest steps that show the problem. “Connect,
join channel, click X” beats “I have used the app for three
weeks and yesterday Y stopped working”.
One bug per issue
Two unrelated bugs need two issues. They get fixed independently
and shipped in different releases.
Versions
“Latest” is not a version. Help, About, copy the exact string.
Maintainers reproduce against a specific build.
Logs
Always attach debug logs. See
Debug logging .
“It does not work” with no further detail.
A 1000-line screenshot of the bug screen with no log.
Multiple unrelated issues in one report.
A wall of text describing how you feel about the bug. Save that for
the comment thread.
Do not file security issues as public GitHub issues.
Instead, email the maintainers privately or use the GitHub “Security
advisories” feature on the repo. Both are linked from the repo’s
Security tab.
Open as a regular issue, but use the enhancement label. Include:
The problem you are trying to solve.
The expected behavior.
Optional: a sketch of how it could work.
Maintainers prefer “problem-shaped” requests (here is a pain) over
“solution-shaped” ones (please add this exact button).
You can:
Subscribe to an issue to get notified about updates.
Add a thumbs-up reaction to “vote” for an issue. Comments like
“+1” are discouraged, use the reaction.
If you can fix it yourself, even better:
Fork the repo.
Create a branch.
Open a draft PR early to discuss approach.
Link the issue with Fixes #123.
Add a test if you can.
Read the CONTRIBUTING.md in the repo first for code style rules.
Maintainers triage new issues within a few days. If your issue gets
no reply after a week:
Add more context (logs, repro, video).
Tag the issue in the project’s discussion channel.
Persistence with patience is the right balance.
Bug reports are the only way the maintainers know something is
broken. Every well-shaped issue makes the project better. Thanks
for taking the time.