¶ Reporting a bug
Aaaaah, bugs. Yes, it is annoying. But how to fight against it ?
Disclaimer: 99% of the time, we are aware of the bugs.
Kindly check your XDA thread/telegram group/discord device thread before reporting it to your maintainer.
PLEASE AVOID SPAMMING. It will only lead to your ban.
¶ I've found a bug ! What should I do ?
Here is a list of things you can do before rushing to talk with your maintainer on Discord, XDA...
- Check the Q&A section of the website.
- Check your device's group chat (XDA Thread, Discord server, telegram group or whatever)
- Check on internet if it's not a common issue wiht known fixes.
- Try to fix the issue by yourself.
¶ I've done what is said above, but no one reported it yet...
Okay, maybe your bug is unknown. You should report it to your maintainer obviously, but there is a way to do so !
Maintainers need real bugs report, not just complaints.
If you want to please your maintainer, here is how you should make a bug report.
-
- You will need to write the description of the bug.
-
- Please include the procedure of reproducing of it.
-
- If possible, provide the error link.
-
- If you don't have an error link, provide an
adb logcatand upload it on our paste server.
- If you don't have an error link, provide an
Tip: when an application crashes, you can get a log link ! Actually, the crash log will be sent to our server to make the bug report easier.
How can I take a logcat?
You can use ADB to record a logcat by using the command:
adb logcat -d
Alternatively you can use the syslog or LogFox.
¶ Example bug report format
- Bug description:
<write the description of the bug here> - How to reproduce:
<write the method of reproducing the bug here> - Logcat:
<upload your logcat to ourpaste serverand paste the link here> - Screenshots:
<you can attach screenshots to the bug report>
¶ Why do I need to keep the bug reporting rules?
It is way easier for the developer and for other users as well, to see your bug report organized and not just a complaint.
This way the developer will be able to implement a solution to the bug you found and other users won't re-report the bug.
