diff options
Diffstat (limited to 'BUGS.md')
| -rw-r--r-- | BUGS.md | 29 |
1 files changed, 17 insertions, 12 deletions
@@ -1,24 +1,29 @@ ## Reporting bugs -Please include the following when reporting bugs: +### What to include +A bug report should contain these 4 things: -* Operating system used -* Version of Qt used, any relevant information if you built it yourself -* Detailed explanation of the bug: - * what was done - * what was expected - * what happened +#### Environment +This includes program version; operating system used; version of Qt or other +libraries; any relevant information if you built from source. -An example of a bad bug report is: +#### Steps to reproduce +Give detailed steps on how to reproduce the problem. Start from the beginning, +mention the actions involved, and be verbose. -> Something happened, and when I pressed the button it broke. +#### Expected result +It's important to include the result you were expecting, as it might differ +from the way the program was designed to work. -An exmaple of a good bug report is: - -> When I opened xyz menu and pressed abc, nothing happened. +#### Actual result +It is also important to include a good description of the buggy behaviour +itself as well, because it's possible that following your steps on a different +system doesn't reproduce the issue. Send bug reports to _aqua at iserlohn dash fortress dot net_. +_Adapted from the guide in the texmate repository._ + ## Known bugs ### Search terms in address bar |