Before reporting
Before submitting a bug report, please:Check existing issues
Search the existing issues to see if your bug has already been reported. This helps avoid duplicates and lets you add information to existing reports.
Verify it's reproducible
Try to reproduce the bug to confirm it’s consistent and not a one-time occurrence.
How to report a bug
We use GitHub Issues to track bugs for OpenComic.Report a Bug
Create a new issue on GitHub
Information to include
When submitting a bug report, please include as much relevant information as possible to help us reproduce and fix the problem quickly:Required information
Description of the bug
Description of the bug
Provide a clear and concise description of what the bug is and what you expected to happen.
Steps to reproduce
Steps to reproduce
List the exact steps to reproduce the behavior:
- Go to ’…’
- Click on ’…’
- Scroll down to ’…’
- See error
System information
System information
Include details about your environment:
- Operating System: Windows, macOS, or Linux (include version)
- OpenComic Version: Check in Help > About OpenComic
- Installation Method: Installer, portable, Snap, Flatpak, AppImage, etc.
Optional but helpful
Screenshots or videos
Screenshots or videos
Visual aids can help explain the problem more clearly. Include screenshots or screen recordings if applicable.
Sample files
Sample files
If the bug is related to a specific comic file or format, consider providing:
- The file format (CBZ, CBR, PDF, etc.)
- File size and structure details
- A sample file if possible (without copyright concerns)
Error messages
Error messages
Include any error messages or console output you see. If available, check:
- Developer Tools console (if you can access it)
- Application logs
Frequency
Frequency
Mention how often the bug occurs:
- Always
- Sometimes
- Only under specific conditions
What happens next
After you submit a bug report:- Maintainers will review - The OpenComic team will review your report
- You may be asked for more information - We might ask follow-up questions to better understand the issue
- The bug will be prioritized - Based on severity and impact
- You’ll be notified - You’ll receive updates on the issue through GitHub
Be patient - the OpenComic team consists of volunteers who work on the project in their free time.
Tips for effective bug reports
- Be specific: Vague descriptions make bugs harder to fix
- Be concise: Include relevant details but avoid unnecessary information
- Be respectful: Remember that maintainers are volunteers
- Follow up: Respond to questions from maintainers promptly
- One bug per report: Don’t combine multiple unrelated bugs in one issue
Other ways to help
If you’re interested in contributing beyond bug reports:Contributing Guide
Learn how to contribute code to OpenComic
Translations
Help translate OpenComic into your language
