diff --git a/docs/bug-reports.md b/docs/bug-reports.md new file mode 100644 index 0000000000..868b8ca9b3 --- /dev/null +++ b/docs/bug-reports.md @@ -0,0 +1,22 @@ +# 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) diff --git a/docs/index.rst b/docs/index.rst index 5a3ea468d5..8c79fa5a10 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -106,6 +106,7 @@ Contents: chat-zulip-org zulipbot-usage accessibility + bug-reports .. _code-testing: