Minimal Reproducible Example – help me help you

You found a problem in one of my libraries? Thanks for letting me know!
I want to fix it, but I need your help:
Please create a Minimal Reproducible Example (reprex) that I can run.

Why

I don’t see what you see.
It works for me, otherwise I would have already fixed it.
So to fix your problem, I need to run a program that reproduces it on my machine.
Only then can I see what causes it and what changes will fix it.

Reproducible

An image is not enough if I can’t recreate it on my own.
A code snippet is no good if it references your own code that I don’t have.
Give me code that I can run and debug.

Minimal

Not your whole project, not private code. Just a small project with enough code to show the problem.

How to create a repex – the easy path

  1. Fork the library repo. (How to fork?)
  2. Open the project in the Example directory.
  3. Change the code there to make the problem appear.
  4. Commit and push.

Now just link to your fork in your bug report, and write the steps to reproduce the problem.

That’s it! Thanks for helping me help you.

Leave a Reply