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 ...
- 59.8k
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 ...
- 88.3k
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 ...
- 4,767
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.
- 88.3k
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 ...
PeilonrayzMod
- 44.6k
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% ...
MastMod
- 13.8k
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 ...
- 12.7k
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 ...
- 24.5k
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 ...
- 75.6k
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 ...
- 146k
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 ...
MastMod
- 13.8k
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 ...
- 20.3k
13
votes
Accepted
Are Advent Of Code questions on topic once we receive no points for them?
Yes
Welcome to Code Review! Thank you for being cautious.
Doing a search on Code Review for questions containing “advent of code” yields 95 results, many of which contain the tag ...
Sᴀᴍ OnᴇᴌᴀMod
- 29.6k
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 ...
- 88.3k
12
votes
Accepted
If porting code, should I also post the original?
I think this mostly depends on what you want to accomplish:
Reimplement the whole exact feature set of the original as exactly as possible (so a "pure" translation).
In this case, we'd need to see ...
- 6,528
12
votes
Why should I be able to answer my own question in the question's editor on Code Review?
I cannot conceive of a reason to have the answer-immediate option on a question post. Sure, we do have good reasons to answer our own questions, but there's no good reason to answer it at the same ...
- 98.1k
12
votes
Accepted
Should we censor rude language in comments/strings of posted code?
Language in Posts and editing profanities generally
For this section, let's assume that profanity was not forbidden
Stack Exchange is a site for users starting at the age of 13 (16 in EU). It's also ...
- 25.5k
12
votes
Accepted
Requesting a comparative review of own code with third-party code
Code Review only allows for reviews of code that is written/maintained by the author. We have that requirement for multiple reasons, including legal (copyright) and moral (to avoid code-shaming).
...
- 146k
11
votes
Accepted
Are questions mostly unrelated to the presented code on-topic?
Existing rules
These are covered in multiple questions
Question body:
Should a post with no specific question(s) imply a general review?
Should [programming-challenge] questions require a summary of ...
PeilonrayzMod
- 44.6k
10
votes
Are practical user-created languages suitable for a tag creation?
I think about this not as a user-created language but as a Code Review community project.
Most importantly: Don't create a tag too soon. In my opinion it's easier to create tags than get rid of them. ...
- 59.8k
10
votes
Accepted
Given CR's question title policy, how to title a second question about the same program?
Creating different titles for follow-ups is difficult, so most follow-up questions tend to have very similar titles which is perfectly fine. Some options for naming a follow-up question is:
XYZ ...
- 59.8k
9
votes
Is it okay to post questions that don't contain a full program/library?
You are always welcome to post just part of your code for review. It is always best though, to provide enough context to make sure the code you post is sensible.
The code you post does not need to ...
- 98.1k
9
votes
Accepted
Let's update the modal for new askers
Question close stats for the 30 days leading to 2020-05-17 are:
Close Reason
Closed
% of total
Missing Context
51
20.08%
Broken
147
57.87%
Migrated
12
4.72%
Authorship
12
4.72%
Custom
4
1.57%
Needs ...
PeilonrayzMod
- 44.6k
9
votes
Accepted
Can I ask a question about a custom scripting language?
Can I ask a question about a custom scripting language?
Yes, if there is a compiler / transpiler / interpreter that we can obtain to run the language through.
I translated it because I felt the ...
PeilonrayzMod
- 44.6k
9
votes
Accepted
Do questions require specific problems, or are general reviews on-topic?
Yes. "Do I want feedback about any or all facets of the code?" means all questions are open to general reviews, even if you mention a specific aspect you want reviewed. Questions don't need ...
- 88.3k
8
votes
Is it ok to post code that didn't work out as intended?
Sorta.
So, here's the thing about your question: it sounds like a case of a A vs. B problem, that is very subjective as to whether it's on-topic or not, but, generally, we lean towards the side of on-...
- 20.3k
8
votes
Accepted
How many questions with same script can I ask, if code not only merged reviews but adds new functionality
How many questions with same script can I ask, if code not only merged reviews but adds new functionality?
If it has new functionality (or even when it doesn't but it has been rewritten significantly ...
MastMod
- 13.8k
8
votes
Review one-by-one feature?
The short answer is, if you know that your code has deficiencies that need to be fixed, then it is not ready to be reviewed here.
In general, we expect questions to have no known bugs. It might be ...
- 146k
8
votes
Accepted
Code review of YouTube video
Questions on Code Review must have the code in the post.
Can I put my code on a third party site and link to the site in my question?
Reviews of code not stored here
Can I ask for a review on a ...
PeilonrayzMod
- 44.6k
7
votes
Why should I be able to answer my own question in the question's editor on Code Review?
You might have already received some code review from elsewhere. You could include it in your question, asking what people think about those suggested changes, but asking for a review of a code review ...
Only top scored, non community-wiki answers of a minimum length are eligible