zulip/docs/contributing/bug-reports.md

24 lines
783 B
Markdown

# Bug report guidelines
Please include these elements in your bug report to make it easier for us to help you.
- A brief title
- An explanation of what you were expecting vs. the actual result
- Steps to take in order to reproduce the buggy behavior
- Whether you are using Zulip in production or in the development
environment, and whether these are old versions
- Whether you are using the web app, a desktop app or a mobile device
to access Zulip
- Any additional information that would help: screenshots, GIFs, a
pastebin of the error log
Further reading:
- [How to write a bug report that will make your engineers love you](https://testlio.com/blog/the-ideal-bug-report/)
- [How to Report Bugs Effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html)