User bug reporting
Written by Mitchell Farguhar
Updated at June 14th, 2024
Table of Contents
In Bolt version 3.17 we have added the ability to allow users to quickly send a bug report to dedicated support address.
A bug report in Bolt consists of the logs txt file and a copy of the user's Google Play or Apple receipt if present.
In Bolt versions 3.16 and below the only way for end-users to send this bug report was to navigate to the Logs view and share the bug report via the OS' share sheet, outlined in our doc about sharing app logs.
Receipts
Google Play or iTunes receipts are only attached in the bug report from Bolt version 3.14 and above
We've now upgraded this functionality to make the bug reporting system much quicker, allowing less back and forth between the end-user and support teams in order to obtain the bug report information and files.
From Bolt 3.17 we have added an extension on the current `/c/logs` deeplink to support `/c/logs/send` which will automatically skip the logs view from appearing and go straight to sharing the bug report.
This new deeplink can be added as a URL settings item in your settings tab to allow users to select a link to send their bug report information.
As well as this, there is now a new ‘support email’ configuration option. This is optional and when configured with a dedicated email recipient(s), the app will automatically pre-fill these recipient(s), the subject and body of the email. The only other interaction end-users will need to do is to add any extra information to the email body and send the email!
User cases
iOS end-users will need to have the iOS Mail App preinstalled and configured with an email account for this to work
Android end-users should automatically be sent to their preferred email app, though if multiple are installed they should also be able to select the email application to use. This could also be subject to the Android system and/or the installed email applications.
If the support email configuration is not filled with client's support recipient email(s), or in the case of iOS, the user does not have the iOS Mail app installed and configured, we will fallback onto the usual operating system's share sheet. Selecting an email provider in this case should automatically attach the bug report files, but we may be unable to pre-fill the email recipient, and support for pre-filling the subject field is also dependent on the email application provider.
In this case we would recommend utilising the copy string `logs_email_intro` to place some copy asking the user to add the client's support email recipient address to the email - this string will be automatically inserted into the email body, allowing the user to quickly cut and paste the relevant email address.