A bug report should contain these 4 things:
- Steps to reproduce: Give detailed steps on how to reproduce the problem.
- Start from scratch (e.g. “1. Opened App, 2. Typed xyz …”).
- Explicitly mention every action involved, and how you invoked it (e.g., rather than “delete the text”, say “Select Cut from the Edit menu” or “Press ctrl+X”).
- Keep the number of steps to a minimum.
- Expected result: It’s important to include the result you’re expecting, as it might differ from how the program was designed to work.
- Actual result: This is also important, since it’s possible that following your steps on a different system doesn’t reproduce the issue. (Screenshots are helpful)
- Environment: This includes:
- OS version
- SikhiToTheMax version
- Other possibly relevant information (for example, if you’re seeing graphics artifacts on a retina MacBook Pro, you should include that)