44 votes

What would Clippy say?

No code in the question Very easy to test for. If there is not a single formatted full line of code in a question: Code Review questions must include the code to be reviewed in the body of the ...
Kaz's user avatar
  • 8,790
44 votes

Must the code be "clean"?

Make the code as clean as you can before submitting it for review. The more work you put into your code, the more you're likely to get out of review. That's because reviewers (especially the ...
Gareth Rees's user avatar
  • 49.6k
33 votes
Accepted

Should I leave in documentation in code for review?

Is it a best practice to include things like function documentation and inline comments when posting code for review? If you normally document your code, then include the documentation when posting ...
Simon Forsberg's user avatar
32 votes
Accepted

Must the code be "clean"?

No it doesn't have to be clean. It can get reviewed, but people will point those problems out. If you know they are bad you should probably clean them, that way we won't badger on about them, and ...
Peilonrayz's user avatar
  • 43.3k
28 votes

What would Clippy say?

Machine Learning There's way too many cases to consider here, we should apply Machine Learning to this to make a machine learn what makes a question likely to be a bad question. I have recently ...
Simon Forsberg's user avatar
27 votes

Found a serious bug in my question after posting it

If the question has been answered, you must not edit it in a way that would invalidate the answers; that is not permitted on Code Review. If the question is still unanswered, and the bug is easily ...
Toby Speight's user avatar
26 votes
Accepted

Should I include my testing code?

Yes, if you have automated tests, please include them. Some folks will take the posted code and paste it into a dev environment/IDE and make changes there (so they can ensure that their answer has ...
Donald.McLean's user avatar
25 votes

What would Clippy say?

Title contains "this * code" or "do* this" Every single question with "this code" or "this [language] code" in the title has been retitled, closed, and/or downvoted; some have comments asking for ...
200_success's user avatar
23 votes

Hide the "describe what you've tried" bullet (new askers' modal)

Yes. This statement implies that if you've tried and failed, then you can post your non-working attempt on CR. We should remove that instruction.
Toby Speight's user avatar
22 votes

What would Clippy say?

Title that looks like a question The following patterns in a question title predict a problematic post: How …? Can …? Should …? Would …? …? (i.e., a title that ends with a question mark) The tip ...
200_success's user avatar
22 votes

Is asking for a review of boiler plate for a minimal repro okay?

The line between real and hypothetical code is sometimes blurry, but I would consider this code sample to be on the wrong side of the line for Code Review. Code that contains ...
200_success's user avatar
22 votes

Code Review Clippy

Yay! Thanks! Just one note, if I would see this as an entirely new user: Titles that contain a specific question are generally inappropriate for Code Review. I would be very confused. If I would ...
Simon Forsberg's user avatar
20 votes
Accepted

Policy regarding "flooding" Code Review with questions

To be completely clear: homework[1] [2] and coding challenges are on-topic. Issues with tags should be edited, it's rare to get questions with perfect tags - I get them wrong all the time too. This ...
Peilonrayz's user avatar
  • 43.3k
20 votes
Accepted

Small portion of reviewable code isn't mine, but credited

Not a problem If it would be a problem, you wouldn't be allowed to use someone else's libraries either. That rule is there to prevent people from dumping code that they don't understand and/or 80% ...
Mast's user avatar
  • 13.4k
19 votes
Accepted

Clarifying Code Review Scope

It really depends on your intention writing your question! Are you looking to make your code work on other browsers? If so, you're looking for someone to write a new feature/fix bugs for you, in this ...
IEatBagels's user avatar
  • 12.4k
18 votes

What would Clippy say?

Body contains only code, or only a few, short, non-code parts This could indicate that the user is not explaining what their code doing and it, more or less, providing a code dump. The message could ...
SirPython's user avatar
  • 13.3k
18 votes

What would Clippy say?

Title or body contains the word "wrong" or "incorrect" These words almost always indicate that the code is broken. The tip could say: Please note that questions containing code that produces ...
200_success's user avatar
18 votes

Should I leave in documentation in code for review?

Going purely from subjective impressions and without actually checking them, quite a lot of my answers specifically point out parts of the code which I think are underdocumented. There are at least ...
Peter Taylor's user avatar
  • 24.1k
17 votes
Accepted

Is this question popularity normal?

The algorithm that makes a question hit the Hot Network Questions (HNQ) list isn't public AFAIK, but it definitely involves views, votes, answers, and a time factor is documented here. Your question ...
Mathieu Guindon's user avatar
16 votes
Accepted

If in doubt, post the question on Meta first?

The best thing to do is to read the Help Center, and specifically, in your case, where your questions are not off-topic, but not that well received: How do I ask a good question? That said, Meta is ...
Phrancis's user avatar
  • 20.4k
16 votes
Accepted

Are you allowed to post incomplete programs that you still want reviewed?

The help center helps out: I'm confused! What questions are on-topic for this site? Simply ask yourself the following questions. To be on-topic the answer must be "yes" to all questions: ...
Mast's user avatar
  • 13.4k
15 votes
Accepted

Rehash “How secure is my X” cryptography questions

With so many Stack Exchange sites, there is bound to be some overlap of scopes. And that's OK. The important principle to note is that a question being a better fit elsewhere is not a sufficient ...
200_success's user avatar
15 votes

Code Review Clippy

That's awesome!! Thanks a million! This will certainly help improve question quality on the site in a major way. The only tiny little quibble I have is that it seems the forecolor for the x button and ...
Mathieu Guindon's user avatar
14 votes
Accepted

Should I be asking shorter questions?

Your code is average, maybe a bit on the large size, nothing that I'd not answer. Your problem is I see a wall with code, text, some lists, more text, more code, more text, more code and then 'how ...
Peilonrayz's user avatar
  • 43.3k
14 votes
Accepted

How can I fix a question in order to make it adhere to Code Review guidelines?

There was some confusion. At the time that the second question was posted, the two questions really did contain identical code — hence its closure as a duplicate. Furthermore, since the first ...
200_success's user avatar
14 votes
Accepted

Multiple related question titles

Let me know if I am allowed to do this You're allowed to do this, and it has been done before. However, it's not a particularly good idea with regards to question clarity and quality. This is one of ...
Mast's user avatar
  • 13.4k
13 votes

How much research effort is expected when posting a Code Review question?

I don't think that there is a minimum level of code quality that people should have to meet. Other than working of course. Bad code can make for good reviews. And I don't think that the primary ...
mdfst13's user avatar
  • 21.6k
13 votes
Accepted

How should I post literate code?

Code Review wants to see your code in context. In general, you should post the "real" code in the state that you normally work with. If it's literate code, then post it as literate code. To get the ...
200_success's user avatar
13 votes
Accepted

Good format to post code for review

We actually have a few guides on how to ask good questions: How to get the best value out of Code Review - Asking Questions Checklist for how to write a good Code Review question Simon's Guide for ...
Der Kommissar's user avatar
13 votes
Accepted

May I post a question whose code is written in a programming language about which nothing exists in Code Review Stack Exchange?

Yes, as long as it's clearly a programming language, and not purely configuration or markup. From your description of Asymptote, it sounds that it is fine in this respect. As a new user (less than ...
Toby Speight's user avatar

Only top scored, non community-wiki answers of a minimum length are eligible