Rules for the issue tracker

From FirebugWiki

(Difference between revisions)
Jump to: navigation, search
m (Added another good example for comments)
m (Added another good and bad example for comments)
 
(8 intermediate revisions not shown)
Line 2: Line 2:
== General rules ==
== General rules ==
 +
 +
'''Note:''' Actually these rules do not just apply to the [http://code.google.com/p/fbug/issues/list issue tracker], but also to our [https://groups.google.com/forum/#!forum/firebug discussion group] and to the [irc://irc.mozilla.org/firebug Firebug IRC channel].
 +
=== Be polite ===
=== Be polite ===
-
Don't shout at us. We're a small team of mostly volunteer developers, which spend their short spare time to make Firebug better. We like everybody, who wants to give constructive contributions to the Firebug project.
+
Don't shout at us or other users. We're a small team of volunteer developers, which spend their spare time to make Firebug better. We like everybody, who wants to give constructive contributions to the Firebug project.
 +
Also other users might not have enough experience with Firebug yet. So don't angry, if they don't understand immediately what you tell them.
 +
 
If you're completely frustrated about Firebug, then we advise you to scream into a pillow and drink some tea before you disclose us your grief.
If you're completely frustrated about Firebug, then we advise you to scream into a pillow and drink some tea before you disclose us your grief.
Line 11: Line 16:
=== Use a common language ===
=== Use a common language ===
Try to explain yourself in English. We're an inhomogenous team living in different places all around the world. And other users may also want to participate in an issue's discussion.
Try to explain yourself in English. We're an inhomogenous team living in different places all around the world. And other users may also want to participate in an issue's discussion.
-
Also to make it easier for others to understand what you mean, you should use the Firebug Terminology for elements inside Firebug.
+
Also to make it easier for others to understand what you mean, you should use the [[Firebug Terminology]] for elements inside Firebug.
== Rules for creating issues ==
== Rules for creating issues ==
Line 24: Line 29:
The issue summary should reflect the contents of your report, i. e. by reading it somebody should be able to understand what the issue covers.
The issue summary should reflect the contents of your report, i. e. by reading it somebody should be able to understand what the issue covers.
-
'''Bad example:'''
+
'''Bad examples:'''
 +
I have a problem
 +
 
  Firebug is not working as expected
  Firebug is not working as expected
-
'''Good example:'''
+
Feature request for the HTML panel
 +
 
 +
'''Good examples:'''
  "Break On Next" is not working when being clicked while script execution is stopped
  "Break On Next" is not working when being clicked while script execution is stopped
 +
 +
Net panel scrollbars show up when not necessary
 +
 +
Show @charset rules inside CSS panel
==== Describe it well, but keep it brief ====
==== Describe it well, but keep it brief ====
Line 36: Line 49:
==== Put code blocks into attachments ====
==== Put code blocks into attachments ====
-
Instead of posting parts of code into your issue description, you should put them into a file and attach that instead. This keeps the issues readable.
+
If the code blocks you want to post are longer than 5 lines, you should put it into a file and attach that instead of directly posting it into your comment. This keeps the issues readable.
== Rules for commenting on issues ==
== Rules for commenting on issues ==
Line 55: Line 68:
  I also see this issue.
  I also see this issue.
 +
 +
Why is this bug still not fixed?
 +
 +
I'd love to see this feature in Firebug!
'''Good examples:'''
'''Good examples:'''
-
  Instead of creating an entry in the context menu, the option should be in the panel toolbar. That makes it more visible.
+
  Instead of creating an entry in the context menu, the option should be in the panel toolbar. That would make it more visible.
-
  Tried the test case on Win7 + FF 7.0.1 + FB 1.8.3 and it fails for me.
+
  Tried the test case on using FF 11.0 + FB 1.9.1 on Windows 7 and it fails for me.
-
  I can't reproduce that issue running on Mac OS X + FF 10.0a1 (Nightly) + FF 1.9.0a3 (SVN)
+
  I can't reproduce that issue running on Mac OS X + FF 14.0a1 + FF 1.10.0a5
  If I set the missing variable "xyz" via the Command Line, the problem disappears.
  If I set the missing variable "xyz" via the Command Line, the problem disappears.
 +
 +
There is a new Firefox API, which you could use to implement this. See the following URL: ...
'''Note, instead of "+1" posts you should use the star button to vote for an issue.'''
'''Note, instead of "+1" posts you should use the star button to vote for an issue.'''
 +
 +
== See also ==
 +
* [[FAQ]]
 +
* [[I found a Firebug Bug!]]
 +
* [[I am missing a feature in Firebug!]]
 +
* [[Creating a Test Case]]

Latest revision as of 11:01, 30 March 2012

We really appreciate every bug report and enhancement request you give us. Though there are some golden rules you should follow when creating issues or commenting on them.

Contents

[edit] General rules

Note: Actually these rules do not just apply to the issue tracker, but also to our discussion group and to the Firebug IRC channel.

[edit] Be polite

Don't shout at us or other users. We're a small team of volunteer developers, which spend their spare time to make Firebug better. We like everybody, who wants to give constructive contributions to the Firebug project. Also other users might not have enough experience with Firebug yet. So don't angry, if they don't understand immediately what you tell them.

If you're completely frustrated about Firebug, then we advise you to scream into a pillow and drink some tea before you disclose us your grief.

[edit] Be available for requests

If you posted on an issue, you should be available for further questions from our side. If we don't get feedback from you for long and can't reproduce your issue, we will close it!

[edit] Use a common language

Try to explain yourself in English. We're an inhomogenous team living in different places all around the world. And other users may also want to participate in an issue's discussion. Also to make it easier for others to understand what you mean, you should use the Firebug Terminology for elements inside Firebug.

[edit] Rules for creating issues

[edit] Read how to create issue reports

First read what to do when you found a bug or have a suggestion for improvement. Reading through that and following the steps described there already solves most of the issues you experience.

[edit] Create a test case

When your issue is not reproducible for us, we can't fix it! If you can't provide a test case, please ask in the Firebug discussion group or in the Firebug IRC channel instead.

[edit] When creating the issue

[edit] Add a meaningful summary

The issue summary should reflect the contents of your report, i. e. by reading it somebody should be able to understand what the issue covers.

Bad examples:

I have a problem
Firebug is not working as expected
Feature request for the HTML panel

Good examples:

"Break On Next" is not working when being clicked while script execution is stopped
Net panel scrollbars show up when not necessary
Show @charset rules inside CSS panel

[edit] Describe it well, but keep it brief

Describe your issue as detailed as possible. You should always keep in mind, that somebody else reading your issue should easily understand what you're talking about.

This also means, that you shouldn't write a whole story around your issue. Keep it short. It makes it much easier for people to follow your descriptions.

[edit] Put code blocks into attachments

If the code blocks you want to post are longer than 5 lines, you should put it into a file and attach that instead of directly posting it into your comment. This keeps the issues readable.

[edit] Rules for commenting on issues

[edit] Just post constructive input

Avoid comments, that are not helping us to solve an issue. This is just flooding the mail boxes of people subscribed to an issue. Instead you should try to help us solving the issue, i. e. provide more information about an issue.

E. g. constructive input can be:

  • Creating a test case to an issue, that doesn't have one yet
  • Trying a test case on another system
  • Describing a different view on an issue
  • Giving a hint how to solve an issue
  • Providing a patch for an issue

Bad examples:

+1
me, too
I also see this issue.
Why is this bug still not fixed?
I'd love to see this feature in Firebug!

Good examples:

Instead of creating an entry in the context menu, the option should be in the panel toolbar. That would make it more visible.
Tried the test case on using FF 11.0 + FB 1.9.1 on Windows 7 and it fails for me.
I can't reproduce that issue running on Mac OS X + FF 14.0a1 + FF 1.10.0a5
If I set the missing variable "xyz" via the Command Line, the problem disappears.
There is a new Firefox API, which you could use to implement this. See the following URL: ...

Note, instead of "+1" posts you should use the star button to vote for an issue.

[edit] See also

Personal tools