[Workshop] SDC: Refining a bug report

[illicitonion]

Workshop Request

What is the title of your workshop

Refining a bug report

What are the key topics that will be covered in the workshop?

In the Legacy Code module we will present our trainees with a buggy implementation of a clone of Twitter.

We will give them a range of bug reports they need to investigate and fix. Some of these will be really well-specified with precise reproduction instructions and impact. Others will be super vague.

We want to consider:

• What makes a good/useful bug report
• What kind of questions we can ask about a bug to find out the missing information
• What we can work out for ourselves by putting in effort, and what we actually need the reporter to tell us.

The outcome of this workshop should be that the trainees can ask good questions about the bad bug reports, and refine them into bugs that can be investigated and fixed.

What knowledge does the trainee need before starting?

No specific knowledge.

What are the topics that will not be covered in the workshop?

Anything requiring a programming language. We're just going to talk about the bug reports themselves, not dig into code to fix them.

Any other notes?

Ideally I'd like this to fit inside 90 minutes, but taking less is fine.

Completion

When completed the lesson plan and exercises should be added as a markdown file to https://github.com/CodeYourFuture/CYF-Workshops

[SallyMcGrath]

https://github.com/CodeYourFuture/CYF-Workshops/tree/main/reporting-bugs

Might be helpful