Skip to main content
replaced http://codereview.stackexchange.com/ with https://codereview.stackexchange.com/
Source Link

The Help Center pageHelp Center page and its Deficiencies

What types of questions should I avoid asking?


First, make sure that your question is on-topic for this site. In short, questions seeking open-ended feedback on real working code that you own or maintain are on-topic for Code Review.

Here are some examples of questions that are unsuitable for Code Review.

Troubleshooting, debugging, or understanding code snippets

Code Review is for open-ended questions about code that already works correctly (to the best of your knowledge). Questions seeking help about debugging or understanding code are off-topic for Code Review, and may be on-topic for Stack Overflow.

Best practices in general

It's OK to ask "Does this code follow common best practices?", but not "What is the best practice regarding X?" Questions should not contain purely generic, hypothetical code, such as

if condition_a:
    do_something()
else if condition_b:
    do_something_else()
else:
    do_something_even_different()

Also watch out for hypothetical wording, such as "Imagine" or "Let's say we have…"

Higher-level architecture and design of software systems

We review code, not concepts, diagrams, or outlines. Whiteboard-style questions may be suitable on Software Engineering if they are specific.

Tools and tips for conducting code reviews

Questions about code review methodology should be asked on Software Engineering.

For questions about the Code Review site itself, please visit our meta-discussion site, where you can talk about things like what questions are appropriate and what tags should be used, suggest features, point out bugs, or generally discuss how this site works.

The Help Center page and its Deficiencies

What types of questions should I avoid asking?


First, make sure that your question is on-topic for this site. In short, questions seeking open-ended feedback on real working code that you own or maintain are on-topic for Code Review.

Here are some examples of questions that are unsuitable for Code Review.

Troubleshooting, debugging, or understanding code snippets

Code Review is for open-ended questions about code that already works correctly (to the best of your knowledge). Questions seeking help about debugging or understanding code are off-topic for Code Review, and may be on-topic for Stack Overflow.

Best practices in general

It's OK to ask "Does this code follow common best practices?", but not "What is the best practice regarding X?" Questions should not contain purely generic, hypothetical code, such as

if condition_a:
    do_something()
else if condition_b:
    do_something_else()
else:
    do_something_even_different()

Also watch out for hypothetical wording, such as "Imagine" or "Let's say we have…"

Higher-level architecture and design of software systems

We review code, not concepts, diagrams, or outlines. Whiteboard-style questions may be suitable on Software Engineering if they are specific.

Tools and tips for conducting code reviews

Questions about code review methodology should be asked on Software Engineering.

For questions about the Code Review site itself, please visit our meta-discussion site, where you can talk about things like what questions are appropriate and what tags should be used, suggest features, point out bugs, or generally discuss how this site works.

The Help Center page and its Deficiencies

What types of questions should I avoid asking?


First, make sure that your question is on-topic for this site. In short, questions seeking open-ended feedback on real working code that you own or maintain are on-topic for Code Review.

Here are some examples of questions that are unsuitable for Code Review.

Troubleshooting, debugging, or understanding code snippets

Code Review is for open-ended questions about code that already works correctly (to the best of your knowledge). Questions seeking help about debugging or understanding code are off-topic for Code Review, and may be on-topic for Stack Overflow.

Best practices in general

It's OK to ask "Does this code follow common best practices?", but not "What is the best practice regarding X?" Questions should not contain purely generic, hypothetical code, such as

if condition_a:
    do_something()
else if condition_b:
    do_something_else()
else:
    do_something_even_different()

Also watch out for hypothetical wording, such as "Imagine" or "Let's say we have…"

Higher-level architecture and design of software systems

We review code, not concepts, diagrams, or outlines. Whiteboard-style questions may be suitable on Software Engineering if they are specific.

Tools and tips for conducting code reviews

Questions about code review methodology should be asked on Software Engineering.

For questions about the Code Review site itself, please visit our meta-discussion site, where you can talk about things like what questions are appropriate and what tags should be used, suggest features, point out bugs, or generally discuss how this site works.

replaced http://meta.codereview.stackexchange.com/ with https://codereview.meta.stackexchange.com/
Source Link
replaced http://meta.codereview.stackexchange.com/ with https://codereview.meta.stackexchange.com/
Source Link

The Help Center page and its DeficienciesDeficiencies

What types of questions should I avoid asking?


First, make sure that your question is on-topic for this site. In short, questions seeking open-ended feedback on real working code that you own or maintain are on-topic for Code Review.

Here are some examples of questions that are unsuitable for Code Review.

Troubleshooting, debugging, or understanding code snippets

Code Review is for open-ended questions about code that already works correctly (to the best of your knowledge). Questions seeking help about debugging or understanding code are off-topic for Code Review, and may be on-topic for Stack Overflowmay be on-topic for Stack Overflow.

Best practices in general

It's OK to ask "Does this code follow common best practices?", but not "What is the best practice regarding X?" Questions should not contain purely generic, hypothetical code, such as

if condition_a:
    do_something()
else if condition_b:
    do_something_else()
else:
    do_something_even_different()

Also watch out for hypothetical wording, such as "Imagine" or "Let's say we have…"

Higher-level architecture and design of software systems

We review code, not concepts, diagrams, or outlines. Whiteboard-style questions may be suitable on Software Engineering if they are specific.

Tools and tips for conducting code reviews

Questions about code review methodology should be asked on Software Engineering.

For questions about the Code Review site itself, please visit our meta-discussion sitemeta-discussion site, where you can talk about things like what questions are appropriate and what tags should be used, suggest features, point out bugs, or generally discuss how this site works.

The Help Center page and its Deficiencies

What types of questions should I avoid asking?


First, make sure that your question is on-topic for this site. In short, questions seeking open-ended feedback on real working code that you own or maintain are on-topic for Code Review.

Here are some examples of questions that are unsuitable for Code Review.

Troubleshooting, debugging, or understanding code snippets

Code Review is for open-ended questions about code that already works correctly (to the best of your knowledge). Questions seeking help about debugging or understanding code are off-topic for Code Review, and may be on-topic for Stack Overflow.

Best practices in general

It's OK to ask "Does this code follow common best practices?", but not "What is the best practice regarding X?" Questions should not contain purely generic, hypothetical code, such as

if condition_a:
    do_something()
else if condition_b:
    do_something_else()
else:
    do_something_even_different()

Also watch out for hypothetical wording, such as "Imagine" or "Let's say we have…"

Higher-level architecture and design of software systems

We review code, not concepts, diagrams, or outlines. Whiteboard-style questions may be suitable on Software Engineering if they are specific.

Tools and tips for conducting code reviews

Questions about code review methodology should be asked on Software Engineering.

For questions about the Code Review site itself, please visit our meta-discussion site, where you can talk about things like what questions are appropriate and what tags should be used, suggest features, point out bugs, or generally discuss how this site works.

The Help Center page and its Deficiencies

What types of questions should I avoid asking?


First, make sure that your question is on-topic for this site. In short, questions seeking open-ended feedback on real working code that you own or maintain are on-topic for Code Review.

Here are some examples of questions that are unsuitable for Code Review.

Troubleshooting, debugging, or understanding code snippets

Code Review is for open-ended questions about code that already works correctly (to the best of your knowledge). Questions seeking help about debugging or understanding code are off-topic for Code Review, and may be on-topic for Stack Overflow.

Best practices in general

It's OK to ask "Does this code follow common best practices?", but not "What is the best practice regarding X?" Questions should not contain purely generic, hypothetical code, such as

if condition_a:
    do_something()
else if condition_b:
    do_something_else()
else:
    do_something_even_different()

Also watch out for hypothetical wording, such as "Imagine" or "Let's say we have…"

Higher-level architecture and design of software systems

We review code, not concepts, diagrams, or outlines. Whiteboard-style questions may be suitable on Software Engineering if they are specific.

Tools and tips for conducting code reviews

Questions about code review methodology should be asked on Software Engineering.

For questions about the Code Review site itself, please visit our meta-discussion site, where you can talk about things like what questions are appropriate and what tags should be used, suggest features, point out bugs, or generally discuss how this site works.

Site name change http://meta.codereview.stackexchange.com/q/7052
Source Link
200_success Mod
  • 145.7k
  • 4
  • 114
  • 284
Loading
updating to match implemented version
Source Link
Pops StaffMod
  • 101
  • 1
  • 7
  • 19
Loading
deleted 4 characters in body
Source Link
200_success Mod
  • 145.7k
  • 4
  • 114
  • 284
Loading
deleted 10 characters in body
Source Link
200_success Mod
  • 145.7k
  • 4
  • 114
  • 284
Loading
Added anti-examples previously on [help/on-topic]
Source Link
200_success Mod
  • 145.7k
  • 4
  • 114
  • 284
Loading
Added (lame) example
Source Link
user34073
user34073
Loading
Stripped out tons of irrelevant stuff
Source Link
200_success Mod
  • 145.7k
  • 4
  • 114
  • 284
Loading
Source Link
200_success Mod
  • 145.7k
  • 4
  • 114
  • 284
Loading
Post Made Community Wiki by 200_successMod