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
76
votes
4answers
8k 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 ...
61
votes
5answers
4k 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 ...
29
votes
4answers
2k 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 ...
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 - ...
19
votes
5answers
399 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 ...
17
votes
4answers
351 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 ...
32
votes
6answers
559 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? ...
18
votes
4answers
369 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
2answers
251 views

Are we allowed to ask questions about just regular expressions?

Are we allowed to ask questions just about regular expressions?
26
votes
5answers
338 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: ...
14
votes
3answers
518 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 ...
28
votes
1answer
484 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.
14
votes
1answer
249 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 ...
35
votes
3answers
558 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 ...
21
votes
3answers
404 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 ...
18
votes
3answers
261 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
553 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 ...
15
votes
2answers
270 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 ...
10
votes
1answer
224 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 ...
43
votes
12answers
865 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
3answers
209 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 ...
19
votes
4answers
311 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 ...
14
votes
3answers
158 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 ...
8
votes
2answers
158 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 ...
27
votes
4answers
393 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 ...
14
votes
3answers
210 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 ...
20
votes
9answers
257 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 ...
15
votes
4answers
106 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 ...
12
votes
3answers
469 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 ...
12
votes
3answers
121 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" ...
11
votes
1answer
158 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 ...
10
votes
1answer
239 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
138 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: ...
7
votes
1answer
117 views

Can I ask a question about overall architecture without much specific code?

I have code, but my question is about overall design patterns. Ideally, I would ask a question describing the design decisions made in my project but would have minimal actual code samples. Is this ...
4
votes
1answer
85 views

How should I ask this big question?

I am currently working on one of my first projects with Python and my first project with PyQT. I would like to post this as a question, to see if there are any improvements I can make. The project is ...
4
votes
2answers
144 views

Should I ask a separate question?

This examples applies for web mainly, but could apply for other stuff also. Let's say I develop a web plugin that has both JavaScript code and CSS. Should I post one question to review the ...
3
votes
0answers
58 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
112 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 ...
2
votes
1answer
66 views

Are implemented API reviews without code on-topic?

I've been reading through the various questions asking whether or not API reviews are on topic, but they've left me a bit confused. In particular "Are questions about public interface (API) on topic?"...
1
vote
1answer
79 views

Posting a whole project, ready for public review [duplicate]

Say I have an open source project hosted on GitHub or wherever, currently in the public review, testing, and bug reporting phase. The Asking page says: ...feedback on a specific working piece of ...
20
votes
3answers
151 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 ...
13
votes
2answers
149 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 ...
13
votes
2answers
140 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 ...
10
votes
1answer
159 views

What's the proper way to ask for database review?

I'm currently designing a database that I wanted to get some input on. It's entirely theoretical at this point, I haven't written a single line of SQL. Would it be acceptable to just post the database ...
9
votes
1answer
130 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 ...
9
votes
1answer
100 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/...
7
votes
1answer
127 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 ...
7
votes
2answers
206 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: ...
6
votes
2answers
148 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 ...
26
votes
3answers
251 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 ...