Bug Reporting
Table of Contents
When you experience an error (“bug”) when using the application, you probably are not very happy, and neither are the developers. We need to hear from you to fix this, and you can do two things to help out:
a) Enabling Crash Reporting in the app (Settings > Logging > Send crash reports). See below for more details.
b) Filing a report on the issue tracker. See below for more details.
Enable crash reporting
Enable crash reporting in the Settings, in the sub entry Logging, where you can toggle “Send anonymous crash reports”. Now, whenever the app crashes, it will save a few details about the crash and sends them the next time you open the app.
Create a report
Creating a bug report helps the developers to get more context and allows other users to join in if they experience the same issue. Steps to create a report:
-
Log in to your Github account. Create a new one if you do not have one yet.
-
Head over to github.com/x0b/rcx/issues
-
Look through the existing issues. Maybe your issue was already reported.
-
Create a new issue with as many details as possible, including:
- App version (e.g. 1.11.4)
- Phone model/Manufaturer (e.g. Samsung Galaxy S10)
- Android Version (e.g. 11.0)
- Any error messages you received from the app or Android
- You may also include a redacted configuration file. To redact your config, replace any
password = ...
,token = ....
,sas_url = ...
or other kind of credential.
Please also include a detailed description as to when the issue occurs.
Problems and solutions
The app crashes before I can reach the settings
If you are unable to reach that setting because the app crashes on startup, you can also directly access the app settings (Android 7+).
- Open the Android Settings
- Navigate to your apps overview list and look for “RCX”
- Open the RCX app info
- Depending on your Android version, now either select ⚙️ or “Additional settings in the app” which should open the app settings directly.
I have enabled crash reporting, but my issue seems to be ignored
There are a few possible reasons for this
a) You downloaded a version that does not have crash reporting (F-Droid, or any release of v1.11.1)
b) The crash report was never received, e.g. you did not open the app again or you did not have an internet connection
c) and many more.
In any case, the developers will only know of this if you create a report.