Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Add bug report guidelines.

This commit is contained in:
Vaida Plankyte 2017-08-07 11:18:17 +01:00 committed by Tim Abbott
parent 5a6169a13f
commit b6da398e17
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/bug-reports.md Normal file
View File

@ -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)

1
docs/index.rst
View File

@ -106,6 +106,7 @@ Contents:
chat-zulip-org chat-zulip-org
zulipbot-usage zulipbot-usage
accessibility accessibility
bug-reports
.. _code-testing: .. _code-testing: