The FAQ states [emphasis mine]:

Code Review - Stack Exchange is for sharing code from projects you are working on for peer review. If you are looking for specific feedback about…

  • Code correctness
  • Best practices and design pattern usage in your code
  • ...

But then it continues with what I find contradicting:

and your question is not about …

  • Tools, best practices, improving, or conducting code reviews
  • Trouble-shooting, debugging, or understanding code snippets
  • ...

So is asking for improvement allowed or not?

Distinction between asking about code correctness and Trouble-shooting looks blurry too. And even if it can be correctly distinguished, it still leaves one ponder why are the latter considered bad questions.


2 Answers 2

up vote 9 down vote accepted

Regarding "best practices, improving, or conducting code reviews": Here "improving or conducting code reviews" is supposed to refer to questions like "How do I properly conduct code reviews", not "Please review/improve this piece of code". The latter is of course perfectly on topic and what this site is for.

The distinction between code correctness and debugging is supposed to be that in the former case you post code that you think is correct (because it compiles and gave you the correct result for your test input) and you're asking us whether we see any problems with the code (like a logic flaw which leads to wrong output for certain edge cases - or maybe a memory leak or something like that). Note that useful response to that question might be something along the lines of "There will be wrong output in this one case" without actually telling you how to fix it (obviously people will tell you how to fix it if they know, but it's perfectly valid for people to just point out the mistake if they don't immediately know how to fix it).

If you want to fix a specific bug this is different because you're asking people to find one specific bug for you instead of just generally looking for problems. The basic workflow of this site is supposed to be that people look through your code and give you their 2 cents on any possible problems they see (be it possible bugs, readability problems or possible performance bottlenecks). If you restrict the question to one specific bug, that runs counter to that workflow. Also the question being specific makes it on-topic on Stack Overflow.

Thanks. I have had first question closed on other SE sites, so I wanted to make sure I will not be asking an off-topic. I can see that a fair amount of effort has been put into compiling the FAQ too, but it still leaves room for opposing interpretations. Your answer here clears those for me though. –  Majid Fouladpour Aug 29 '11 at 11:30
@sepp2k: I get what you're saying, but the FAQ really should clarify this better. It's kind of confusing and could lead to a lot more questions like this. IMHO. –  Herbert Sep 1 '11 at 7:00
I also found this confusing, so rephrasing "conducting code reviews" to "how to conduct code reviews" would be clearer. –  AndrewC Apr 9 '13 at 10:15

I'd reword the FAQ to say this:

and your question is not about …

  • Tools, best practices, improving, or how to conduct code reviews
better yet: "process improvement" –  Ben Voigt Oct 16 '11 at 1:12

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .