Skip to main content
edited tags
Link
Mathieu Guindon Mod
  • 75.6k
  • 4
  • 99
  • 243
Tweeted twitter.com/#!/StackCodeReview/status/477759297036623872
added 20 characters in body; edited tags; edited title
Source Link
200_success Mod
  • 145.6k
  • 4
  • 114
  • 284

Checklist for questions on CRhow to write a good Code Review question

Many questions of new users lack some parts or common style of the site. There already are some meta questions that aggregate tips on this issue but letting new users walk through all of them is probably very discouraging.

Instead I would propose to make a community wiki question and answer with a short checklist for posting questions on CR.

It must be short enough to not scare people from reading it through and it should provide links to more detailed meta questions that explain why.

An example could be

  1. Check that your code works -> link to help center for on topic questions
  2. Choose title -> link to meta post with some good question titles
  3. Check that your code works -> link to meta post with some rough guidelines where to post non working code
  4. Choose title -> link to meta post with some good question titles
  5. Copy&paste your working code -> link to meta post on "Which parts of code may be ommitted"
  6. Add some context about the overall algorithm and the usage in your program
  7. [Optional] State major concerns or objectives for the review directions
  8. Add at least the tag of the language you are using
  9. Post and enjoy

So what do you say? Should we put up such a list? What should it look like/what should the items be?

Should we even go one step up and make a flowchart on how to use the SE network during programming to get people to better understand when to post on CR?

Checklist for questions on CR

Many questions of new users lack some parts or common style of the site. There already are some meta questions that aggregate tips on this issue but letting new users walk through all of them is probably very discouraging.

Instead I would propose to make a community wiki question and answer with a short checklist for posting questions on CR.

It must be short enough to not scare people from reading it through and it should provide links to more detailed meta questions that explain why.

An example could be

  1. Check that your code works -> link to help center for on topic questions
  2. Choose title -> link to meta post with some good question titles
  3. Check that your code works -> link to meta post with some rough guidelines where to post non working code
  4. Copy&paste your working code -> link to meta post on "Which parts of code may be ommitted"
  5. Add some context about the overall algorithm and the usage in your program
  6. [Optional] State major review directions
  7. Add at least the tag of the language you are using
  8. Post and enjoy

So what do you say? Should we put up such a list? What should it look like/what should the items be?

Should we even go one step up and make a flowchart on how to use the SE network during programming to get people to better understand when to post on CR?

Checklist for how to write a good Code Review question

Many questions of new users lack some parts or common style of the site. There already are some meta questions that aggregate tips on this issue but letting new users walk through all of them is probably very discouraging.

Instead I would propose to make a community wiki question and answer with a short checklist for posting questions on CR.

It must be short enough to not scare people from reading it through and it should provide links to more detailed meta questions that explain why.

An example could be

  1. Check that your code works -> link to help center for on topic questions
  2. Check that your code works -> link to meta post with some rough guidelines where to post non working code
  3. Choose title -> link to meta post with some good question titles
  4. Copy&paste your working code -> link to meta post on "Which parts of code may be ommitted"
  5. Add some context about the overall algorithm and the usage in your program
  6. [Optional] State major concerns or objectives for the review
  7. Add at least the tag of the language you are using
  8. Post and enjoy

So what do you say? Should we put up such a list? What should it look like/what should the items be?

Should we even go one step up and make a flowchart on how to use the SE network during programming to get people to better understand when to post on CR?

Source Link

Checklist for questions on CR

Many questions of new users lack some parts or common style of the site. There already are some meta questions that aggregate tips on this issue but letting new users walk through all of them is probably very discouraging.

Instead I would propose to make a community wiki question and answer with a short checklist for posting questions on CR.

It must be short enough to not scare people from reading it through and it should provide links to more detailed meta questions that explain why.

An example could be

  1. Check that your code works -> link to help center for on topic questions
  2. Choose title -> link to meta post with some good question titles
  3. Check that your code works -> link to meta post with some rough guidelines where to post non working code
  4. Copy&paste your working code -> link to meta post on "Which parts of code may be ommitted"
  5. Add some context about the overall algorithm and the usage in your program
  6. [Optional] State major review directions
  7. Add at least the tag of the language you are using
  8. Post and enjoy

So what do you say? Should we put up such a list? What should it look like/what should the items be?

Should we even go one step up and make a flowchart on how to use the SE network during programming to get people to better understand when to post on CR?