Stack Exchange Network

Stack Exchange network consists of 175 Q&A communities including Stack Overflow, the largest, most trusted online community for developers to learn, share their knowledge, and build their careers.

Visit Stack Exchange

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.

17
votes
2answers
472 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 ...
9
votes
1answer
102 views

Provide links to official style guides when writing questions

The answers to many questions tagged python on CodeReview start with or otherwise include references to PEP-0008, the official Python Style Guide. Many reviews include comments on use of whitespace (e....
16
votes
3answers
125 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 ...
9
votes
2answers
117 views

Reviewing software, not only code

I'm looking for some people/community who are doing each others' software reviews, but not only code. Actually code is the least important. I would like somebody look at my software as a whole and ...
51
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 ...
6
votes
1answer
80 views

Asking for comparison of design of two code snippets giving same functionality

I had asked for the review of the part of a jQuery and as per the answer I made changes in the file. Now after making the changes (mainly moving from triggers to functions) I am not so sure whether I ...
19
votes
5answers
378 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 ...
11
votes
3answers
439 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 ...
4
votes
1answer
88 views

How should really big code challenge submissions be reviewed? [duplicate]

As far as I am aware, a question consisting of a really big codebase is generally off-topic here, as our answerers are simply not able to put so much effort in it. I'd like to talk about a special ...
19
votes
4answers
355 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 ...
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 ...
8
votes
1answer
60 views

Ask for review on JavaScript code style/structure, usage of patterns, and general quality of the solution

I have code I want to get reviews for. It's not a particular problem, and the code actually works wonders. I just want to see what other experts can suggest in order to make it better, improve style,...
25
votes
5answers
313 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
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 ...
14
votes
3answers
147 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 ...
32
votes
2answers
474 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 ...
5
votes
3answers
84 views

Are questions on design only requiring minimal code off topic?

I asked this question which someone has flagged as off topic, referencing a question that referred to pseudo code as a reason. My question is in regards to the overall design and not changes to how ...
8
votes
2answers
136 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
2answers
312 views

Review code on Github? [duplicate]

Someone might sometimes want a review of a longer length of code: for example this question references some code stored here on their private web site. It isn't necessarily feasible or desirable to ...
7
votes
1answer
127 views

Good question, but OP didn't know how to ask it?

In Calculating Julian dates, the author asks a question that doesn't make sense: Refactor this code so that I don't have to insert the parameters any time I need to use one of the functions. [....
8
votes
3answers
117 views

Proper way to ask best practices questions

https://codereview.stackexchange.com/questions/37601/how-bad-is-duplicating-a-code-block This got closed as off-topic. I read the help center and from it I concluded that rather than present possible ...
39
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 - ...
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/...
6
votes
1answer
45 views

Codeblock detection

The idea jumped at me after reviewing two close votes in a row (granted, from the same user) that were homework assignments without any code in it. Since a question that has no code in it (or one ...
13
votes
2answers
133 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 ...
9
votes
1answer
123 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 ...
6
votes
3answers
90 views

Can I ask a question to review an FAQ written on a third-party site?

I wrote an FAQ on a third-party website related to Delphi and thread-protection of objects. I need some feedback if this content is adequate or not. I was wondering can I ask a question on Code Review ...
7
votes
1answer
107 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 ...
9
votes
1answer
146 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 ...
10
votes
1answer
216 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 ...
16
votes
4answers
331 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 ...
4
votes
1answer
50 views

“How To Ask” text should link to help center, not faq

Similar to my question here, Code Review's "How To Ask" text should link to the help center, rather than the FAQ: Interestingly, CR's Meta seems to be more up to date than SO's:
7
votes
2answers
201 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: ...
14
votes
1answer
231 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 ...
3
votes
2answers
127 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 ...
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: ...
11
votes
2answers
200 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 ...
12
votes
2answers
130 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 ...
8
votes
1answer
141 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 ...
4
votes
1answer
92 views

Is a question mostly pertaining to build configuration appropriate for this site?

I'm currently creating a somewhat complex Maven project (specifically, to automate this answer), and hence would like to submit it for review here - specifically, the POM and the general structure of ...
20
votes
3answers
355 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 ...
4
votes
1answer
95 views

What does a piece of code need to satisfy to be a “real project” by itself?

Currently, the FAQ provides the following guidelines: Code Review - Stack Exchange is for sharing code from projects you are working on for peer review. You should only ask practical, answerable ...
12
votes
3answers
475 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 ...
8
votes
1answer
239 views

Where do high-level architecture and design questions go?

The FAQ states this: your question is not about … Higher-level architecture and design of software systems So, where should a high-level design question go?
18
votes
3answers
251 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 ...
2
votes
1answer
115 views

Cross-posting etiquette

Is it okay to copy a previous post from Stack Overflow, in the interests of building questions during the beta stage of Code Review? I'm perfectly happy with the answers I received for the question ...
27
votes
1answer
453 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.