From 8037b9d2eec0ff883117af08125b3a456128b233 Mon Sep 17 00:00:00 2001 From: Lauren Van Sloun Date: Wed, 2 Oct 2019 10:44:52 -0400 Subject: [PATCH] Updated MCVE/MVCE to reprex to mirror StackOverflow's changes --- stackoverflow/nomcve.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/stackoverflow/nomcve.md b/stackoverflow/nomcve.md index 08f4053..d9528a8 100644 --- a/stackoverflow/nomcve.md +++ b/stackoverflow/nomcve.md @@ -1,22 +1,23 @@ --- -title: No MCVE -byline: lacking an MCVE makes it hard to answer +title: No reprex +byline: lacking a reprex makes it hard to answer permalink: nomcve/ categories: "Stack Overflow" redirect_from: - NoMCVE - nomvce - NoMVCE + - NoREPREX + - noreprex --- -## Without a Minimal, Complete, Verifiable Example, it is hard to know what is wrong {#introduction} +## Without a Minimal, Reproducible Example, it is hard to know what is wrong {#introduction} {::comment}In this paragraph, give the user the tl;dr lowdown. {:/} A question without any code, or where the code provided is not * minimal – as little code as possible that still produces the same problem * complete – contains all parts needed to reproduce the problem - * verifiable – would compile if run, and exhibits the problem described in the question -cannot be easily, if at all, answered. + * reproducible – would compile if run, and exhibits the problem described in the question -When a code sample has these qualities, it is generally referred to as an [MCVE](https://stackoverflow.com/help/mcve). +When a code sample has these qualities, it is generally referred to as a [reprex](https://stackoverflow.com/help/minimal-reproducible-example). ## Why this is a problem {#whythisisaproblem} {::comment}In this section, detail why the post has problems{:/} @@ -24,15 +25,15 @@ Without code, users will have to guess what might be wrong with a person's code. ## Why this is worth a downvote {#whythisisworthadownvote} {::comment}In this section, you can describe why the problem is worth a downvote within the community in which it was posted{:/} -Without an MCVE included in a question, it is much harder to answer. This also means it is now much more unlikely the question will get an answer. Experienced users may be able to determine the problem, but it will take them longer than necessary to do so. Or, they may be reduced to guessing at possible reasons until they guess right, or give up. This is considered rude as it wastes the time of those trying to help. +Without a reprex included in a question, it is much harder to answer. This also means it is now much more unlikely the question will get an answer. Experienced users may be able to determine the problem, but it will take them longer than necessary to do so. Or, they may be reduced to guessing at possible reasons until they guess right or give up. This is considered rude as it wastes the time of those trying to help. -Another huge benefit of an MCVE is that people can just copy paste the code and run it to observe it's exact behavior. Many times when people help, they write code in order to help find a solution. Having an MCVE spares them the work of converting example code into an application that exhibits the problems described in the question. +Another huge benefit of a reprex is that people can just copy paste the code and run it to observe its exact behavior. Many times when people help, they write code in order to help find a solution. Having a reprex spares them the work of converting example code into an application that exhibits the problems described in the question. ## What to do next {#whattodonext} {::comment}In this section, cover how the problem can be fixed.{:/} -Create an MCVE! There are a [number](https://stackoverflow.com/help/mcve) of [tutorials](http://www.sscce.org/) available, some of which are part of larger "how to ask a good question" guides, such as [this one](https://codeblog.jonskeet.uk/2010/08/29/writing-the-perfect-question/) (see the "Sample code and data" section). Read them! They are there to help you. +Create a reprex! There are a [number](https://stackoverflow.com/help/minimal-reproducible-example) of [tutorials](http://www.sscce.org/) available, some of which are part of larger "how to ask a good question" guides, such as [this one](https://codeblog.jonskeet.uk/2010/08/29/writing-the-perfect-question/) (see the "Sample code and data" section). Read them! They are there to help you. -Once you have a good grasp of the concept, go back and edit your question. If you have too much code, clean it up! Remove everything that doesn't have to do with the logic that the question asks about. For example, remove empty lines and comments, if not relevant to the question. If the code contains HTML markup, remove CSS and layout details that aren't part of the question. +Once you have a good grasp of the concept, go back and edit your question. If you have too much code, clean it up! Remove everything that doesn't have to do with the logic that the question asks about. For example, remove empty lines and comments if they're not relevant to the question. If the code contains HTML markup, remove CSS and layout details that aren't part of the question. If you don't have code, create a [prototype](https://en.wikipedia.org/wiki/Software_prototyping) that only covers exactly what your logic is trying to do. Make it as clean and simple as possible, and make sure it reproduces your error. You may be surprised to find out that you discover what your problem was by simply taking this step! But, if not, you can then use this prototype to add code to your question.