Reporting bugs: Difference between revisions

From Miranda NG
Jump to navigation Jump to search
No edit summary
(some enhancement and sceenshots)
Line 12: Line 12:


== Effective bug reporting ==
== Effective bug reporting ==
[[File:Reporting bugs 01.png|200px|thumb|Screen 1]]
[[File:Reporting bugs 02.png|200px|thumb|Screen 2]]
Using the following tips will '''greatly''' increase the chances of your issue being '''noticed''' and '''fixed''' quickly.
Using the following tips will '''greatly''' increase the chances of your issue being '''noticed''' and '''fixed''' quickly.


* Have a well-written bug <tt>Summary</tt> field (''This is very important because you cannot edit it later'').
* Have a well-written bug <tt>Summary</tt> field – describe the issue clearly, in simple words (''This is very important because you cannot edit it later'').
* Describe the issue clearly, in simple words.
* <tt>Description</tt> field – provide step-by-step instructions so we can reproduce the issue (''We can't fix what we can't reproduce'').
* Provide step-by-step instructions so we can reproduce the issue (''We can't fix what we can't reproduce'').
* Attach screenshots if possible.
* Attach screenshots if possible.
* Attach a [[version information]] report (''It's desirable to disable bb-code formatting before attaching/posting VersionInfo'').
* Attach your [[version information|VersionInfo]].
* Attach a [[Crash reports|crash report]] if you are experiencing crashes.
* Attach a [[Crash reports|crash report]] if you are experiencing crashes (It includes VersionInfo as well).
* Attach a [[network log]] captured if you are experiencing connectivity issues.<!--
* Attach a [[network log]] captured if you are experiencing connectivity issues.
* Select <tt>Feature Request</tt> template above the summary field if:
* <tt>Type</tt> – select <tt>enhancement</tt> here if:
** you hope to see a new feature in future releases.
** you have a feature request
** you propose an improvement to something that works (graphics, text, layout, etc). -->
** you offer an improvement for something already implemented.
* Specify the other elements of your report, such as: <tt>Priority</tt>, <tt>Severity</tt> (the importance of defect), Miranda <tt>Version</tt> and <tt>Component</tt>. You can also add <tt>Keywords</tt>.
* Specify the other elements of your report, such as: <tt>Priority</tt>, <tt>Severity</tt> (the importance of defect), Miranda <tt>Version</tt> and <tt>Component</tt>. You can also add <tt>Keywords</tt>.
=== How to attach files ===
* Check ''I have files to attach'' and press ''Create ticket'' (see Screen 1).
* Press ''Browse'', select the files you want ot attach and press ''Add attachment'' (Screen 2).





Revision as of 18:49, 20 August 2013

Template:Languages/Report bug We want Miranda as bug free as you do, so help us help you. The most important thing to remember when reporting bugs is to provide complete and accurate information. Most of our time is spent asking for more information and fixing/updating information. So if you report a bug, please take the time to read and follow these recommendations. Our bug tracker: http://trac.miranda-ng.org/report You can easily access it using Miranda: Main Menu → Help → Report Bug.


Before reporting a bug


Effective bug reporting

Screen 1
Screen 2

Using the following tips will greatly increase the chances of your issue being noticed and fixed quickly.

  • Have a well-written bug Summary field – describe the issue clearly, in simple words (This is very important because you cannot edit it later).
  • Description field – provide step-by-step instructions so we can reproduce the issue (We can't fix what we can't reproduce).
  • Attach screenshots if possible.
  • Attach your VersionInfo.
  • Attach a crash report if you are experiencing crashes (It includes VersionInfo as well).
  • Attach a network log captured if you are experiencing connectivity issues.
  • Type – select enhancement here if:
    • you have a feature request
    • you offer an improvement for something already implemented.
  • Specify the other elements of your report, such as: Priority, Severity (the importance of defect), Miranda Version and Component. You can also add Keywords.

How to attach files

  • Check I have files to attach and press Create ticket (see Screen 1).
  • Press Browse, select the files you want ot attach and press Add attachment (Screen 2).


After reporting an issue

  • Monitor the issues you report.
  • Provide feedback and additional information if requested.
  • Don't argue about whether something is a bug or not.