Skip to main content

Minimal Working Examples: How to, Why, and Who cares

When you have a problem and you rush to colleagues, or strangers on IRC and mailing lists, you've got to present a problem they'll want to help you fix, and with all the information they need to fix it. You can't give them information they dont need, because any extra work filing through your unrelated code is going to reduce the chances anyone will put in the time to help you.

We can state a few rules about seeking help with code.
  1. Ask the question clearly and don't be ambiguous about your intentions and requirements.
  2. If you need to include code, it needs to include all important context.
  3. Present the problem without reference to out-of-context issues.
Don't come in with a link to your entire body of code telling us it doesn't work. What doesn't work is asking for help like that. Besides telling us exactly how things don't work, and what they are doing compared to what you are expecting, you need to give us code that specifically and only demonstrates the problem directly at hand. This is our golden "Minimal Working Example", where "working" means that it works just enough to show us how its broken. You need to reproduce the situation causing your code to break, without showing us the environment your code is in when it breaks. That means taking code segments out of their modules and even out of the insides of functions, and surrounding them with just enough jumpstart to fail the same way it did in the original code.

Before you even get around to asking your question, you might solve it simply by isolating the problem into your example. When you remove the problem code from everything else, you can remove the distractions of everything else going on around it. You might remove another part of the code to reduce things to the minimal example, and suddenly find the problem gone, identifying the removed code as the source of your problems. If you think isolating test cases sounds familiar, then you know enough that I shouldn't have to tell you these minimal working examples should already exist in the form of your unit test suites. When something goes wrong, you should have already had a test to catch it, and added one if you didn't. If the problem can be isolated now, keep it isolated for later.

Remember what is important to your problem. If you can't figure out some particular pysqlite2 issue, and you're working with data your extracted from XML files grabbed from a remote server, you can bet the XML, HTTP, and all the logic to process it is not worth your time to show anyone. Your example only needs to show the data you have to push through SQL, and no one should need to see where its come from. If your components are more tightly woven, and separating them isn't possible or is even moderately difficult, then you have a serious design flaw and extracting the problem example has revealed away to clear up your code and likely solve many latent problems, all at once.

Once proper testing, documentation, and isolation have let you up the creek without a paddle, thats where community support comes in. Come to us with the example that tells us right away what the problem is, what its doing, and the obvious thing you think it should have done, instead. We can all run this code and approach it from the same direction as yourself, so we know exactly what your problem is and where to approach the solution.

Comments

Popular posts from this blog

CARDIAC: The Cardboard Computer

I am just so excited about this. CARDIAC. The Cardboard Computer. How cool is that? This piece of history is amazing and better than that: it is extremely accessible. This fantastic design was built in 1969 by David Hagelbarger at Bell Labs to explain what computers were to those who would otherwise have no exposure to them. Miraculously, the CARDIAC (CARDboard Interactive Aid to Computation) was able to actually function as a slow and rudimentary computer.  One of the most fascinating aspects of this gem is that at the time of its publication the scope it was able to demonstrate was actually useful in explaining what a computer was. Could you imagine trying to explain computers today with anything close to the CARDIAC? It had 100 memory locations and only ten instructions. The memory held signed 3-digit numbers (-999 through 999) and instructions could be encoded such that the first digit was the instruction and the second two digits were the address of memory to operat...

Statement Functions

At a small suggestion in #python, I wrote up a simple module that allows the use of many python statements in places requiring statements. This post serves as the announcement and documentation. You can find the release here . The pattern is the statement's keyword appended with a single underscore, so the first, of course, is print_. The example writes 'some+text' to an IOString for a URL query string. This mostly follows what it seems the print function will be in py3k. print_("some", "text", outfile=query_iostring, sep="+", end="") An obvious second choice was to wrap if statements. They take a condition value, and expect a truth value or callback an an optional else value or callback. Values and callbacks are named if_true, cb_true, if_false, and cb_false. if_(raw_input("Continue?")=="Y", cb_true=play_game, cb_false=quit) Of course, often your else might be an error case, so raising an exception could be useful...

How To Teach Software Development

How To Teach Software Development Introduction Developers Quality Control Motivation Execution Businesses Students Schools Education is broken. Education about software development is even more broken. It is a sad observation of the industry from my eyes. I come to see good developers from what should be great educations as survivors, more than anything. Do they get a headstart from their education or do they overcome it? This is the first part in a series on software education. I want to open a discussion here. Please comment if you have thoughts. Blog about it, yourself. Write about how you disagree with me. Write more if you don't. We have a troubled industry. We care enough to do something about it. We hark on the bad developers the way people used to point at freak shows, but we only hurt ourselves but not improving the situation. We have to deal with their bad code. We are the twenty percent and we can't talk to the eighty percent, by definition, so we need to impro...