How to write a bug report

We don’t like bugs, neither you do. I’ve seen a post in jetpack blog talking about this and I’ve found really interesting. I’m going to reproduce here:

Here’s a great rule: if we can’t reproduce the bug, we can’t fix the bug.

When you report a bug to us, here’s what happens:

  1. We read the bug report
  2. One of us tries to reproduce the bug
  3. If we can reproduce it, we investigate what’s broken and fix it
  4. But if we can’t reproduce the bug…

Often bug reports don’t include enough information. Meaning we have go back and ask for details so we can investigate. If you want to increase the odds we fix an issue, and fix it fast, help us out.

A great bug report includes the following:

  1. What were you trying to do?
  2. What did you click on or do last?
  3. What happened / what did you see?
  4. What browser are you using?
  5. What version of OSClass?
  6. What hosting provider? (And if you know, what version of PHP do they use?)
  7. The bug is reported to the right place:
    1. OSClass
    2. Plugins: Specify the plugin and the version
    3. Themes: Specify the theme and the version

Bug reports that show screenshots for #3 are incredibly useful, as we can see exactly what you saw.

Bonus points for reviewing known issues before submitting, as your problem might already have been reported and have a patch or a workaround.

We work hard to have you deal with as few issues as possible, but if you want to improve the odds we can fix your issue fast, please take a extra minute to write a bug report that’s easier for us to use. Thanks.

Source: How to write a great bug report

This entry was posted in Development, Testing. Bookmark the permalink. Juan Ramón

2 Responses to How to write a bug report

  1. kop says:

    Can we not use a bug tracker to report instead?

  2. Juan Ramón says:

    Sure, I was only explaining how to report the bugs but you should report them in the bug tracker. I wrote them in the post but I’m going to write here too:
    OSClass core
    OSClass plugins
    OSClass themes