Questions tagged [asking-questions]

This tag is for questions specifically about the process of asking questions on Code Review; e.g. how to ask, whether specific questions are appropriate, etc.

Filter by
Sorted by
Tagged with
71
votes
4answers
7k views

How to get the best value out of Code Review - Asking Questions

I have a project I am working on, and I would like some, or all of it reviewed, how can I ask for this review on Code Review in a way that produces the best possible value? This is not about a ...
54
votes
5answers
3k views

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 ...
40
votes
1answer
1k views

How to post a follow-up question?

Sometimes I stumble upon follow-up questions, where code is being posted again after having gone through a review (or two). Examples of possible sets of follow up questions: Find missing numbers - ...
29
votes
4answers
1k views

Why is hypothetical example code off-topic for Code Review?

As stated in the Help Center, one of the criteria for a question to be on topic is: Is it actual code from a project rather than pseudo-code or example code? What is the rationale for that ...
19
votes
5answers
385 views

Can we ask reviewers to *not* focus on something?

Our Help Center says: Do I want feedback about any or all facets of the code? However, sometimes we might have some code that we are aware has flaws in it, or we would just for one reason or ...
33
votes
6answers
496 views

Is code ever clean enough? - Can there be too many follow-up questions?

Some posts can at times have several follow-up questions, sometimes a couple of follow-up questions on the same day. All this brings us to the question of Can there be too many follow-up questions? ...
19
votes
4answers
359 views

Should comparisons of code snippets be closed as “not seeking a code review”?

I've been seeing some "A vs. B" questions for a while, and I'm not sure if they're considered on-topic for this site. Many of these questions are not asking for a review, but which code snippet is ...
16
votes
4answers
335 views

Should a post with no specific question(s) imply a general review?

I've started thinking about this more after seeing this question. I'm sometimes tempted to vote such questions as not clear what you're asking, but I also feel that it's not quite needed for this ...
25
votes
5answers
317 views

Do one-liners and other narrowed-down code qualify for a code review?

Every once in a blue moon, a question gets posted (often as a new user's first post) where the OP is asking a quite specific question about very minimalistic code, for example: ...
12
votes
3answers
477 views

Does my code example need to be compilable/runnable?

I'm thinking of posting a question here, but am unsure how I should do so. The question is about comparing the performance of a piece of pure Python code vs a hybrid Python/C++ piece of code, glued ...
27
votes
1answer
455 views

What makes a good question? [duplicate]

I think it would be a good idea to compile a list of guidelines on how to ask good question. What information should be present, how to structure it, etc.
16
votes
2answers
227 views

Are we allowed to ask questions about just regular expressions?

Are we allowed to ask questions just about regular expressions?
33
votes
3answers
496 views

How well is “malicious” code accepted here?

I recently asked a question that could possibly be used for malicious purposes. I tried to whittle the code down as much as I could to a "base" program so that a script kiddie wouldn't stumble across ...
14
votes
1answer
233 views

How should one deal with code asking “Is this correct?” when it is in fact correct?

I'm wondering what a good guideline is when dealing with questions asking (primarily or completely) about correctness. Generally this is not what Code Review is about. However, when the code is ...
15
votes
2answers
261 views

Stop mentioning major concerns in title

On the Ask a Question page, users are currently faced with this: state the purpose of your code, and mention any major concerns. I have recently started commenting on many questions with this ...
43
votes
12answers
801 views

What would Clippy say?

We have a question closure rate of ~30%. That's a significant burden on moderators and users who help triage the questions. While some questions can indeed be very difficult to triage, there are ...
19
votes
4answers
293 views

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

On Stack Overflow, the community consensus for research before asking is: A lot. An absurd amount. More than you think you are capable of. In fact, asking a question on Stack Overflow is the ...
18
votes
3answers
183 views

Reviewing AI based on how it performs

On Code Golf is is common to see a king-of-the-hill question where you have to implement an AI based on the rules given in the question. So then I got to thinking - "If I developed an AI for one of ...
18
votes
3answers
254 views

Reviews of code not stored here

This question is inspired by a question I just saw: Review website done after one week of learning HTML and CSS How do we want to handle these issues? We wanted to avoid pastebins since having the ...
17
votes
2answers
493 views

Should [programming-challenge] questions require a summary of the challenge?

Project Euler has been offline for several days, after the site was hacked. Problem is, a large number of our questions relate to Project Euler, and many of them do not contain any description of the ...
14
votes
3answers
150 views

“How secure…” questions - Code Review vs. Information Security SE

Recently I have seen a whole lot of questions in the form of "How secure is this hashing", "How secure is my keygen?", "How secure is my form?". We do have a quite popular security tag, with 159 ...
10
votes
1answer
217 views

Should mostly working but a little bit broken code stay or be deleted?

I posted the question Parsing structured text in Java At first I thought it was working, later I have found a bug in the code. Should it stay or should it be deleted? Update: I have fixed the bug in ...
20
votes
3answers
356 views

Is it okay to add someone else's linked code to the question?

Some questions link to the code they want reviewed, which is against site policy. Should one edit the code into the question in these cases? The problem I see is that all content on Stack Exchange ...
13
votes
3answers
190 views

Which licenses are compatible with Code Review?

It is should be well known that code posted to Code Review are licensed under CC-BY-SA. I am wondering: Are there any licenses that are compatible with this licensing? Is it possible to use one ...
27
votes
4answers
364 views

Code Review Clippy

A while back, y'all asked for some warnings for folks asking questions here: What would Clippy say? After thorough review (mostly by animuson & JNat), we've determined that the following warnings ...
21
votes
9answers
254 views

Help spot deficiencies in our Help Center

Regular participants will be familiar with procedures and practices on Code Review. For example, we have rules against asking hypothetical questions appending to or modifying the question after ...
11
votes
3answers
448 views

Asking questions - including full code

In my first CR question, I was looking for feedback about my implementation of a graph data structure and an algorithm for depth first traversal, as I am studying these at the moment. Although I ...
10
votes
3answers
108 views

Can I ask the same question with a different language?

I am wondering if it would be bad to ask for the same code review, just under a different language. For example: Hypothetically I post a question asking for a code review of my Ruby "Hello World" ...
10
votes
1answer
230 views

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

Are you allowed to post incomplete programs that you still want reviewed? I made the start of a battleship game, but I want people's opinion before I finish it.
10
votes
1answer
134 views

Questions that ask for you to e-mail them to get the code

What is the appropriate way to handle a question that doesn't post the code to review, but posts an e-mail address that you can I assume e-mail and get the code? A (now-deleted) example is: ...
8
votes
2answers
137 views

Having an entire project reviewed

I have a small project I'm working on in an area I'm not comfortable with (web development). I would like someone to review my code. I can try to split it up, but I would prefer if someone looked at ...
3
votes
0answers
50 views

My code with a small set of classes may be too much [duplicate]

I have a small set of classes that form an events system that I would very much like opinions on, but they're made up of a few classes that together amount to around 1kloc. I'm a little worried that ...
3
votes
1answer
91 views

Text minimum in questions

On all Stack Exchange sites, you can't post answers or questions that are mostly code. You always have to include some text minimum, otherwise you can't post the question. I do understand why this is ...
16
votes
3answers
126 views

Posting a multi-language project

I have a small project for which I would like to ask for a code review soon. However, it integrates multiple languages (specifically, Python + jQuery and the rest of the browser stack). Can such a ...
14
votes
4answers
85 views

Questions about documentation

Are questions about writing/improving documentation appropriate and on-topic for Code Review? And if so, should there be a documentation tag? Let's be clear--I'm not talking about questions seeking ...
13
votes
2answers
137 views

Is asking for review of 3rd party code ok?

Most code people are posting here seems to be code they have written themselves. In this question the OP asked basically for a review of three 3rd party scripts. I'm not sure that this question is a ...
12
votes
2answers
133 views

Is it valid to reask (many) question on same script?

I have asked a question about a Python script a few months ago. Now I have developed that script furthermore fixing the issues described in the answer of that question. Now I have another questions ...
9
votes
1answer
92 views

Encouraging users to include a code-snippet that proves that their code works

I have stumbled across some questions where it is hard to determine whether or not the code in the question actually works or not. Example #1: https://codereview.stackexchange.com/questions/35616/...
9
votes
1answer
124 views

Reviewing usefulness of code

I was wondering if, as part of asking for a review here, can I ask about how useful my code is? That is, getting feedback about what possible use-cases the code I have written has and if people would ...
7
votes
2answers
203 views

Is it okay to ask which snippet is considered the most clean?

Is it on-topic to ask a question with two more or less equivalent snippets, and ask which of the two snippets is considered the most clean? The way I see it, there are four possible answers here: ...
7
votes
1answer
117 views

Is it okay to ask questions about algorithm help?

I have code that solves the "Traveling Salesman" problem using "Kruskal's algorithm" for a code competition site. The code run and generates the correct result, but has O(n3) complexity. I am not ...
5
votes
2answers
133 views

How much context is the required minimum?

This question got sparked by a recent discussion in the 2nd Monitor about this question: Golang Map-Reduce Master - Channels. The problem is: How much context is needed to actually review the code in ...
27
votes
3answers
243 views

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

For asking and answering questions on Stack Overflow with certain frameworks and libraries I have boilerplate lying around for a minimal repro. I would be interested in getting feedback on my WCF ...
20
votes
3answers
325 views

Should we censor rude language in comments/strings of posted code?

What I’m referring to mostly started with this edit where strong language that possibly originated as a joke from the OP was flagged as rude and removed from the question entirely. The code in the ...
16
votes
3answers
167 views

Will a question be downvoted for poor code?

I am kind of new to Code Review SE (I only have two questions), and am trying to understand the site. I recently came across this question with three downvotes. For the most part, It seems that it is ...
15
votes
2answers
112 views

Insufficient “How to ask”

As a newbie coming to CR and asking the very first question you can see There's nothing about broken code there and many new questions seem to get closed quickly because of it. Moreover, it names no ...
12
votes
3answers
178 views

Why should I be able to answer my own question in the question's editor on Code Review?

I don't get why I am allowed to post an answer to my question in the question's editor: I know from Stack Overflow that this feature exists on Stack Exchange websites. It seems relevant for Stack ...
11
votes
2answers
202 views

Is there a need for the OP to mention their expertise?

Is it relevant to include expertise with a code review question? Should this change the code review/answer? For example, this question mentions that the OP is new to the language. I suggested an edit ...
10
votes
1answer
123 views

Posting the same program in three different languages in three different sections [duplicate]

If I made three programs in three different languages, that do the same thing, could I post all three of them and have them connect to one another in order for the review to be successful? Let's say ...
8
votes
1answer
144 views

How should a canonical question title be formatted on Code Review?

See the following 2 questions and their title edits: Calculations with a table containing football data (revisions) Database output function (revisions) While I understand that having all questions ...