Unit 06 · lesson

Write a Reproducible Bug Report

Debugging yourself is one skill.

Helping another person reproduce the failure is another.

Weak report

Jekyll doesn't work. Help.

Nobody knows:

  • your version;
  • command;
  • source structure;
  • expected behavior;
  • actual error;
  • operating environment;
  • whether the failure survives a clean build.

Strong report structure

Title:
Environment:
- OS:
- Ruby:
- Bundler:
- Jekyll:

Command:

Minimal source/config needed to reproduce:

Expected result:

Actual result:

Exact error/output:

Steps to reproduce:
1.
2.
3.

What I already tested:

Minimize the reproduction

If the failure still happens with one page and five lines of config, that is more useful than attaching a 300-file project without explanation.

Do not remove the very thing that causes the bug while simplifying.

Privacy boundary

Before sharing logs or repositories:

  • remove credentials;
  • remove private URLs/tokens;
  • remove unnecessary personal data;
  • check screenshots and config files.

Portfolio action

Turn one Unit 6 incident into a reproducible bug report.

You do not need to publish it upstream.

The artifact is the discipline.

Checkpoint

Give the report to another student. Can they reproduce the symptom without asking what you meant?