Reporting bugs: Difference between revisions

Revision as of 18:57, 5 April 2018

Other languages:

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

Update to the latest development version (see Updating Miranda NG).
Check if the problem persists (it may happen that it has been fixed).
Search the issues for an existing bug report for your problem.

Effective bug reporting

Screen 1: Creating issue

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

Have a well-written bug Title field – describe the issue clearly, in simple words.
Provide step-by-step instructions in Description field 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.
If Miranda freezes, hangs up or consumes CPU, attach information obtained by Process Explorer tool.

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.

@@ Line 1: / Line 1: @@
-{{PageLang|en}}{{Languages/Report bug}}
+<languages/>{{PageLang|en}}{{Languages/Report bug}}
 {{TNT|Important|
-* Please, make bug reports to our [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}}.
+<translate>
-* If you are unsure about the problem or want to bring more attention to it, you can mention it on [https://forum.miranda-ng.org our forum] or [xmpp:miranda-ng-int@conference.jabber.ru?join chatroom] too.}}
+* 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>
 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.
+</translate>
 __TOC__
+<translate>
 == Before reporting a bug ==
 * Update to the latest {{GlossLink|development version}} (see [[Installation and update#Updating Miranda NG|Updating Miranda NG]]).
 * Check if the problem persists (it may happen that it has been fixed).
-* Search the [https://github.com/miranda-ng/miranda-ng/issues issues] for an existing bug report for your problem.
+* Search the [<tvar|github_tracker_url>https://github.com/miranda-ng/miranda-ng/issues</> issues] for an existing bug report for your problem.
 == Effective bug reporting ==
+</translate>
-[[File:Reporting bugs 01.png|200px|thumb|Screen 1: Creating issue]]
+[[File:Reporting bugs 01.png|200px|thumb|<translate>Screen 1: Creating issue</translate>]]
+<translate>
 Using the following tips will '''greatly''' increase the chances of your issue being '''noticed''' and '''fixed''' quickly.
-* Have a well-written bug <tt>Title</tt> field – describe the issue clearly, in simple words.
+* Have a well-written bug <tvar|title_field><tt>Title</tt></> field – describe the issue clearly, in simple words.
-* Provide step-by-step instructions in <tt>Description</tt> field  so we can reproduce the issue (''We can't fix what we can't reproduce'').
+* Provide step-by-step instructions in <tvar|description_field><tt>Description</tt></> field  so we can reproduce the issue (''We can't fix what we can't reproduce'').
 * Attach screenshots if possible.
 * Attach your [[version information|VersionInfo]].
@@ Line 32: / Line 39: @@
 * Attach files by dragging & dropping, selecting them, or pasting from the clipboard
-* Press {{Button|Submit new issue}} (see Screen 1).
+* Press <tvar|submit_button>{{Button|Submit new issue}}</> (see Screen 1).
 == I know when it got broken ==
@@ Line 38: / Line 45: @@
 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 [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.
+* 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.
 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.
@@ Line 47: / Line 54: @@
 * Provide feedback and additional information if requested.
 * Don't argue about whether something is a bug or not.
+</translate>
 [[Category:Help]]