Issues & bugs

Overall

1. Summarizing title

   • Consider the reader. Will everybody know what it's about, and understand?

2. Content

   • No speculation, no suggestions
   • Avoid duplication
   • "Dry" reporting (no emotion)
   • One issue or bug per report
   • Prioritize (don't bug people with unimportant bugs)

3. Description

   • Detailed, but concise. Provide as much context as you can.

4. Design / examples

   • If you don't have a visual, provide an example or something people can relate to.

Bugs

1. System information

   • Device / OS / versions

2. Steps to reproduce

   • Screenshots, when this happened I pressed that, ...

3. Expected result

   • Design, description, example

4. Actual result

   • Screenshots, console log, ...