Skip to content

Reporting Bugs

Jump to bottom
Matthew Taylor edited this page Jan 28, 2016 · 8 revisions

Reporting bugs is one of the most helpful things you can do for Scratch. The more bugs we know about, the more bugs we can fix!

If you think the bug is a security issue, please send an email to [email protected] instead of reporting the bug on this repo. Please include the text "[SECURITY]" in the subject line too.

Otherwise, see below!

It is important, when reporting bugs, to do so in a way that is clearly defined and easy to reproduce. If you encounter a bug on Scratch, here are some important steps to take when opening an issue for it on this repo:

1. Make sure you can reproduce the bug

If it's not reproducible, it will be really hard for us to diagnose what's happening.

2. Open up an issue on this repo

The title of the bug should be descriptive, and use the following format:

[name of functional area of website] brief description of the bug

  • [name of functional area of website] – there are multiple functional areas of the UI. The prefix here in brackets should name the area of the website where the bug popped up.

    • This is very important to have. We are still transitioning Scratch into this repo from its old one, so it will be very helpful for us to know if the bug applies to code on this repo or not.

  • brief description – this shouldn’t be more than one line long, and should as much as possible approximate the way the bug appears in the UI.

The body of the bug report should contain the following information:

  • Operating system used when encountering the bug
    • Bonus bug points* if this includes testing on multiple OS’s
  • Browser used when encountering the bug
    • Bonus bug points* if this includes testing on multiple browsers
  • Steps to reproduce the bug – the more detailed and explicit the steps are, the better

3. Label the bug as “needs-triage” – that way the ST can take a looksy :)

With this information, we can assess how much of an impact the bug is having on users, and determine the priority with which it should be addressed.

* Bonus bug points are completely arbitrary and lack any intrinsic value. But don't tell @mewtaylor.

Clone this wiki locally