Here at the Institute, we talk a lot about best practices when developing software but we rarely talk about best practices for issue/bug reports. Probably one of the most important best practices to follow when reporting an issue/bug is to provide minimal example. Yihui Xie, author of various R packages, wrote the blog post "The Minimal Reproducible Example Paradox" on his blog, which is a reflection of the importance of users dedicate some time to develop a minimal example. With Yihui's permission, we’ve reproduced his post below.
You can access the original post at Yihui Xie's blog.
How many times have I reminded a user of posting a minimal, self-contained, and reproducible example (reprex)? Probably 500 times. How many times do I think I will still need to remind users of this? Perhaps 5000 times.
I think there is a paradox, and there isn’t a clever solution. The paradox is that we software developers know much more about our own software than average users (especially beginners), and we naturally anticipate a reprex, but users are in the dark, not knowing what information to…Continue Reading