Bug/Incident Reporting
Learn how to report bugs found in you mobile apps and Bright products.
Before you submit a bug report 🐛, try to reproduce the issue more than once and trace the issue backwards from:
- App/Browser views
- Bridge Test Requests
- Bright Kit/ Bright API Requests
If you can confirm the bug can be reproduced, or you are sure an issue exists but cannot reproduce it, prepare and send a report.
Report
Send an email with the following information and format:
Field | Value | Notes |
---|---|---|
to: | [email protected] | |
cc: | ||
subject: | Organisation Name/Customer Number - Bug Report | |
body: | Product: App (iOS and/or Android, phone/tablet), Bridge, Documentation, My Pages etc... | Choose one or multiple. |
Type: Bug | Can be: Bug or Incident. | |
Issue Description: Describe the issue in detail. Date of issue discovery, what is broken, version and/or user affected etc... | ||
Reproduction Steps: 1. 2. 3. ... | If you cannot consistently reproduce the error, write "Cannot reproduce" in step 1. | |
Bridge Test Failure: Name of Test | If the issue is not able to be to found in Bridge, skip. | |
Full HTTP Request Example: POST /event HTTP/1.2 Host: staging.domain/v1 apikey: YOURAPIKEY cache-control: no-cache | Use this option if a Bridge test does not correlate to the error and it is found in Bright Kit or Bright API. Easiest place to copy a full request is from the show raw log view in the console from Postman. | |
Full HTTP Response Example: HTTP/1.1 200 OK Content-type: application/json { "status": "", "data": { "success": "", "sentTo": "" } } | Use this option if a Bridge test does not correlate to the error and it is found in Bright Kit or Bright API. Easiest place to copy a full request is from the show raw log view in the console from Postman. | |
attachments: | Screenshots from the browser or mobile device affected. | Send only the screenshot(s) that relates to the issue. |
Updated about 2 months ago