Bug Filing Instructions & Template

[emigenix]

Adding some instructions on how to file a github issue and bugreport.
It can be used a template and we may want to move this info to a Wiki page.

---

Thank you for your feedback! Please add below details so that we can help you a bit faster.

Agreements

• I have reviewed and accepted the guidelines for contributing to this project.
• I have searched the open Issues and made sure I am not filing a duplicate.
• I have read the notes on debugging and will properly maintain this Issue.

Overview

Please add a short and easy to understand description of the issue you have experienced, here.

Include:

• The first ~20 lines from the About screen (paste as code)
• Phone Model and ROM name (if any)
• A link to a logfile without identifiable data. Please use an encrypted pastebin site, to paste long listings. Don't paste them here. (Set life to ~6 months)

Reproduction

Please tell us the detailed steps on how to reproduce your issue, here.

References

If your issue is related to any other existing Issues or pull requests, please link them here.

Screenshots

If you experienced visual glitches, please add a screen-shot without meta-data here.

---

ToDo:

• Add the CONTRIBUTE.md file to root directory

---

HOWTO: collecting debug data

There are two ways to collect debug data from a misbehaving app:

1. Using a root shell and saving a logcat around the time of the problem or issue occurs
2. Using the app built-in dubug_*.gz logs
3. Using the app built-in Submit feedback/questions

(1) From root shell:

alias 

(2) from app debug logs

• In the app, navigate to: Settings >> Development
• Then enable:
  • enable development options [x]
  • Unencrypted logfiles [x]
• Stop recording and exit to restart app (settings update bug)
• Use your favorite file navigation app (such as ES File Explorer )and find debug the files in the path:
  • /data/data/zz.snsn.xlite/files/
  • Then inspect the debug files named: debug_2017-04-17_13-37-00_UTC.gz. (If the file is still encrypted, it will end with *.gz.smime.

(3) By uploading encrypted debug logs to SRLabs from within app:

Go to "menu" >> Submit feedback/questions and selct what you want to upload.

---

WIP: add more options...