Skip to content

Submitting useful bug reports

Matt Kraus edited this page Mar 8, 2017 · 1 revision

Submitting useful bug reports

First, thank you many times over for taking the time to file a bug. For the report to be most effective, we've noticed the following characteristics help us get to a solution the fastest.

Search, search, search

Before submitting a new issue please search if someone has already opened an issue about the same topic. Don't forget to search for both open and closed issues as GitHub only searches for open issues by default. (You may also wish to check out GitHub's help article about search to get more accurate results.)

Come up with a concise and descriptive title

A good title sums the issue in a few words and makes it easily searchable. There's no need to use tags such as "[Feature]" in the titles. Speaking of search: did you try searching duplicate issues by using your title as search keywords?

Try to reproduce the bug

To fix an issue the developers need to see the bug themselves. Try to find the exact conditions and steps that make the bug happen and then write them down on your issue report. Following your steps the developers can hopefully recreate the bug on their own device and fix it.

Device and app information

  • What's your device?
  • What Android version is it running?
  • What version of SecureSuite do you have? (see bottom of the Settings page)

Screen snapshot

Capture a screen snapshot showing the problem.

App state

  • What are the relevant preferences that you have set that may be related to the issue? Some examples:
  • Android app or Web app?
  • Contact list or group list?
  • Importing or exporting?
  • Does your device have sufficient storage space?
  • If this is a bug involving a second party, what's their device/app info and app state?

Developer log

If you are a developer, see if you can include pertinant logcat information. Log files are generally anonomous in nature but make sure you do not include any personal information you would not like to share with the world.

Also note that as a developer, there may be a diagnostic command from the Developer Menu that may help.

Finished!

Clone this wiki locally