Skip to main content
Small typos
Source Link
Tomerikoo
  • 312
  • 1
  • 5

Try to focus your code on to only those things you want reviewed. If you want an algorithm reviewed, thethen try to include only thatthe code that is related to the algorithm. This reduces the amount of 'distraction', and it also means there is less code to read, and criticize. The more code you include in your question, the more opportunity there is for reviewers to find the 'simple' things that are wrong. However, you should try, whenever it is possible, to provide everything required to compile/run your code on its own (sometimes, just a missing import or include can be a pain for a reviewer). It is much easier to suggest an enhancement to the code when one can check that everything seems to work fine once the code is changed (for that reason, unit tests and/or examples with expected output are always welcome - also, they help to describe what your code is supposed to do).

Try to focus your code on to only those things you want reviewed. If you want an algorithm reviewed, the try to include only that code that is related to the algorithm. This reduces the amount of 'distraction', and it also means there is less code to read, and criticize. The more code you include in your question, the more opportunity there is for reviewers to find the 'simple' things that are wrong. However, you should try, whenever it is possible, to provide everything required to compile/run your code on its own (sometimes, just a missing import or include can be a pain for a reviewer). It is much easier to suggest an enhancement to the code when one can check that everything seems to work fine once the code is changed (for that reason, unit tests and/or examples with expected output are always welcome - also, they help to describe what your code is supposed to do).

Try to focus your code on to only those things you want reviewed. If you want an algorithm reviewed, then try to include only the code that is related to the algorithm. This reduces the amount of 'distraction', and it also means there is less code to read, and criticize. The more code you include in your question, the more opportunity there is for reviewers to find the 'simple' things that are wrong. However, you should try, whenever it is possible, to provide everything required to compile/run your code on its own (sometimes, just a missing import or include can be a pain for a reviewer). It is much easier to suggest an enhancement to the code when one can check that everything seems to work fine once the code is changed (for that reason, unit tests and/or examples with expected output are always welcome - also, they help to describe what your code is supposed to do).

Commonmark migration
Source Link

#When you ask your question

When you ask your question

###Title

Title

###Tags

Tags

###Text

Text

###Code

Code

#When you ask your question

###Title

###Tags

###Text

###Code

When you ask your question

Title

Tags

Text

Code

edited body
Source Link
Jamal Mod
  • 34.9k
  • 2
  • 53
  • 106
  • Titles should reflect what your code does, not what concerns you about your code

Titles should reflect what your code does, not what concerns you have about your code.

  • Tags are used by reviewers to find questions to review. Use this to attract people who can help you

Tags are used by reviewers to find questions to review. Use this to attract people who can help you.

  1. describeDescribe the problem your code solves. Give enough context so that a reviewer can perhaps suggest an entirely different solution.
  2. describeDescribe what you think your code does, give a brief text-based description of the 'landmarks' in your code.
  3. giveGive a particular concern you would like reviewers to address, what do you think your weakness is in your code. Why do you want a review?
  • The text is to provide context, explanation, and direction. Be generous with context, and light on chatter.

The text is to provide context, explanation, and direction. Be generous with context, and light on chatter.

  • Code should be in a state that allows your particular concerns to be obvious. If your concerns are hidden behind other issues, then don't expect your concerns to be addressed

Code should be in a state that allows your particular concerns to be obvious. If your concerns are hidden behind other issues, then don't expect your concerns to be addressed.

  • Titles should reflect what your code does, not what concerns you about your code
  • Tags are used by reviewers to find questions to review. Use this to attract people who can help you
  1. describe the problem your code solves. Give enough context so that a reviewer can perhaps suggest an entirely different solution.
  2. describe what you think your code does, give a brief text-based description of the 'landmarks' in your code.
  3. give a particular concern you would like reviewers to address, what do you think your weakness is in your code. Why do you want a review?
  • The text is to provide context, explanation, and direction. Be generous with context, and light on chatter.
  • Code should be in a state that allows your particular concerns to be obvious. If your concerns are hidden behind other issues, then don't expect your concerns to be addressed

Titles should reflect what your code does, not what concerns you have about your code.

Tags are used by reviewers to find questions to review. Use this to attract people who can help you.

  1. Describe the problem your code solves. Give enough context so that a reviewer can perhaps suggest an entirely different solution.
  2. Describe what you think your code does, give a brief text-based description of the 'landmarks' in your code.
  3. Give a particular concern you would like reviewers to address, what do you think your weakness is in your code. Why do you want a review?

The text is to provide context, explanation, and direction. Be generous with context, and light on chatter.

Code should be in a state that allows your particular concerns to be obvious. If your concerns are hidden behind other issues, then don't expect your concerns to be addressed.

meta -> concept - add examples of description-first
Source Link
rolfl Mod
  • 97.5k
  • 4
  • 116
  • 237
Loading
meta -> concept
Source Link
rolfl Mod
  • 97.5k
  • 4
  • 116
  • 237
Loading
Adding comments about code being ready to compile/run.
Source Link
SylvainD
  • 29.3k
  • 12
  • 3
Loading
Source Link
rolfl Mod
  • 97.5k
  • 4
  • 116
  • 237
Loading
Post Made Community Wiki by rolflMod