Difference between revisions of "Reporting bugs"

From Miranda NG
Jump to: navigation, search
(Reporting bugs [en])
 
(add language independent anchor for 'Effective bug reporting')
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Languages/Report bug}}
+
<languages/>
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''.
+
{{TNT|Important|
 +
<translate>
 +
<!--T:1-->
 +
* Please, make bug reports to our [<tvar|github_tracker_url>https://github.com/miranda-ng/miranda-ng/issues</> issue tracker], so they won't get lost on forums or chatroom logs.<br>You can easily access it using Miranda: {{Menu|Main menu|Help|Report bug}}.
 +
* If you are unsure about the problem or want to bring more attention to it, you can mention it on [<tvar|forum_url>https://forum.miranda-ng.org</> our forum] or [<tvar|jabber_chatroom_url>xmpp:miranda-ng-int@conference.jabber.ru?join</> chatroom] too.
 +
</translate>}}
  
 +
<translate>
 +
<!--T:2-->
 +
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 {{Strong|complete}} and {{Strong|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.
 +
</translate>
  
 
__TOC__
 
__TOC__
  
== Before reporting a bug ==
+
<translate>
* Update to the latest stable or development version.
+
== Before reporting a bug == <!--T:3-->
* Check whether the problem persists.
 
* Search the issues for an existing bug report.<!--  
 
* Select "Feature Request" template above the summary field if:
 
** you hope to see a new feature in future releases.
 
** you propose an improvement to something that works (graphics, text, layout, etc). -->
 
  
 +
<!--T:4-->
 +
* Update to the latest {{GlossLink|development version}} (see {{Ll|Installation and update#Updating Miranda NG|Updating Miranda NG}}).
 +
* Check if the problem persists (it may happen that it has been fixed).
 +
* Search the [<tvar|github_tracker_url>https://github.com/miranda-ng/miranda-ng/issues</> issues] for an existing bug report for your problem.
 +
</translate>
  
== Effective bug reporting ==
+
{{Anchor|Effective bug reporting}}
Using the following tips will '''greatly''' increase the chances of your issue being '''noticed''' and '''fixed''' quickly.
+
<translate>
 +
== Effective bug reporting == <!--T:5-->
 +
</translate>
  
* Have a well-written bug <tt>Summary</tt> field (''This is very important because you cannot edit it later'').
+
[[File:Reporting bugs 01.png|200px|thumb|<translate><!--T:6--> Screen 1: Creating issue</translate>]]
* Describe the issue clearly, in simple words.
+
 
* Provide step-by-step instructions so we can reproduce the issue (''We can't fix what we can't reproduce'').
+
<translate>
 +
<!--T:7-->
 +
Using the following tips will greatly increase the chances of your issue being noticed and fixed quickly.
 +
 
 +
<!--T:8-->
 +
* Have a well-written bug <tvar|title_field>Title</> field – describe the issue clearly, in simple words.
 +
* Provide step-by-step instructions in <tvar|description_field>Description</> field  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 Version information'').
+
* Attach your {{Ll|Version information|VersionInfo}}.
* Attach a [[Crash reports|crash report]] if you are experiencing crashes.
+
* Attach a {{Ll|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 {{Ll|Network log|network log}} captured if you are experiencing connectivity issues.
* 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>.
+
* If Miranda freezes, hangs up or consumes CPU, attach {{Ll|Using Process Explorer as the debugging tool|information obtained by Process Explorer tool}}.
 +
 
 +
=== How to attach files === <!--T:9-->
 +
 
 +
<!--T:10-->
 +
* Attach files by dragging & dropping, selecting them, or pasting from the clipboard
 +
* Press <tvar|submit_button>{{Button|Submit new issue}}</> (see Screen 1).
 +
 
 +
== I know when it got broken == <!--T:11-->
 +
 
 +
<!--T:12-->
 +
If you know things got broken in some version or at some particular time, then it's good because you can try different releases from different revisions and narrow down where exactly the problem started to happen:
 +
 
 +
<!--T:13-->
 +
* You can either compile the revisions yourself (that requires more knowledge and time).
 +
* Or ask someone in our [<tvar|jabber_chatroom_url>xmpp:miranda-ng-int@conference.jabber.ru?join</> jabber conference] to help you identify potentially problematic revisions and then ask to compile those revisions for you.
 +
 
 +
<!--T:14-->
 +
Then you can try to reproduce your problem on each of them and find out when exactly it got broken. With that info it's easy to reach out the developer who commited the broken commit and ask him to look at it.
  
 +
== After reporting an issue == <!--T:15-->
  
== After reporting an issue ==
+
<!--T:16-->
 
* Monitor the issues you report.
 
* Monitor the issues you report.
 
* Provide feedback and additional information if requested.
 
* Provide feedback and additional information if requested.
 
* Don't argue about whether something is a bug or not.
 
* Don't argue about whether something is a bug or not.
 +
</translate>
  
[[Category:Помощь]]
+
[[Category:Help{{#translation:}}|{{#getdisplaytitle:{{FULLPAGENAME}}}}]]

Latest revision as of 10:59, 13 June 2018

Other languages:
беларуская • ‎Deutsch • ‎English • ‎polski • ‎русский
Important
  • Please, make bug reports to our issue tracker, so they won't get lost on forums or chatroom logs.
    You can easily access it using Miranda: Main menu → Help → Report bug.
  • If you are unsure about the problem or want to bring more attention to it, you can mention it on our forum or chatroom too.

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.

Before reporting a bug

Effective bug reporting

Screen 1: Creating issue

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

How to attach files

  • Attach files by dragging & dropping, selecting them, or pasting from the clipboard
  • Press Submit new issue (see Screen 1).

I know when it got broken

If you know things got broken in some version or at some particular time, then it's good because you can try different releases from different revisions and narrow down where exactly the problem started to happen:

  • You can either compile the revisions yourself (that requires more knowledge and time).
  • Or ask someone in our jabber conference to help you identify potentially problematic revisions and then ask to compile those revisions for you.

Then you can try to reproduce your problem on each of them and find out when exactly it got broken. With that info it's easy to reach out the developer who commited the broken commit and ask him to look at it.

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.