11
\$\begingroup\$

Just to break the ice with one from the great seven: what should our FAQ contain?

(One FAQ suggestion/answer)

\$\endgroup\$
  • 2
    \$\begingroup\$ perhaps we should stipulate 1 FAQ per answer? \$\endgroup\$ – LRE Jan 19 '11 at 20:58
  • \$\begingroup\$ Sounds like a great initiative, I'll modify. \$\endgroup\$ – Zolomon Jan 19 '11 at 20:59
  • \$\begingroup\$ How should we compile/summarize this FAQ to a complete list? \$\endgroup\$ – Zolomon Jan 19 '11 at 22:20

16 Answers 16

21
\$\begingroup\$

How to post your code? (inline, link, etc.)

\$\endgroup\$
  • 1
    \$\begingroup\$ We really need to get an answer to this in the FAQ. There are a bunch of posts already with links to other sites/source repositories. If its too big to be posted in a question, its probably too big for someone visiting this site to actually be able to review in a timely fashion. \$\endgroup\$ – Mark Loeser Jan 27 '11 at 22:14
  • 1
    \$\begingroup\$ @Mark: If its too big to be posted in a question, its probably too big for someone visiting this site to actually be able to review in a timely fashion. If that's the case then CR will be reduced to reviewing short code snippets. Is that what we want? Is it even useful? \$\endgroup\$ – Herbert Sep 1 '11 at 7:15
19
\$\begingroup\$

What belongs here vs what belongs on StackOverflow

\$\endgroup\$
  • 4
    \$\begingroup\$ And maybe Programmers.SE. I think we should try to collaborate with them. \$\endgroup\$ – TryPyPy Jan 21 '11 at 20:20
  • \$\begingroup\$ Well SE is all one big family after all \$\endgroup\$ – LRE Jan 22 '11 at 4:32
12
\$\begingroup\$

What is the purpose of this site?

\$\endgroup\$
12
\$\begingroup\$

How much code should I provide in my questions?

\$\endgroup\$
  • 2
    \$\begingroup\$ If whole projects (> 100 LOC) are to be reviewed, a link to a permanent pastebin post will suffice otherwise it's OK to insert as a code block? \$\endgroup\$ – Zolomon Jan 19 '11 at 21:14
  • 1
    \$\begingroup\$ Possible answer to FAQ: meta.codereview.stackexchange.com/questions/10/… \$\endgroup\$ – Zolomon Jan 19 '11 at 22:18
10
\$\begingroup\$

Some examples of on-topic and off-topic questions (maybe from the Area 51 page)

\$\endgroup\$
  • \$\begingroup\$ Off topic: "my code is broken, why? can you... review it?" meta.codereview.stackexchange.com/q/44/90 (that's low, preying on geeks eager to review stuff to fix code for you :D) \$\endgroup\$ – TryPyPy Jan 19 '11 at 23:54
8
\$\begingroup\$

When should an answer be accepted?

This feels very ambiguous to me at the moment, even though the site has only been up and running for a few hours, we have several questions without answers. It seems like it'll be difficult to know when to accept an answer. Do we leave it to the satisfaction of the user to decide when enough review has been committed?

\$\endgroup\$
  • 1
    \$\begingroup\$ I think this would be the same as SO, where when the user feels comfortable with using the new approach and it has several up votes, then he would accept that as his personally answer. \$\endgroup\$ – RobertPitt Jan 19 '11 at 23:49
  • \$\begingroup\$ I would upvote this more than once if I could. We need to establish etiquette around it because there won't always be a single correct answer. Maybe we could encourage people to make compilation answers of all relevant points from other answers? \$\endgroup\$ – Inaimathi Jan 20 '11 at 14:54
  • 1
    \$\begingroup\$ I'm pretty much against "accepting" an answer in most cases on this sub site. These are by nature discussion questions accepting an answer infers a "correct" answer. Though I'd take it on a case by case basis. \$\endgroup\$ – Athas May 4 '11 at 10:46
5
\$\begingroup\$

It might be useful to outline some tips on how to "shorten" your code so that only the relevant parts are put on display. Along with that, some guidelines about how much code is too much code.

\$\endgroup\$
5
\$\begingroup\$

How to format code samples

The code should be properly indented and adhere to the language's coding conventions. It should have a maximum line length of 80 characters (which is especially important when not using a pastebin, since longer lines will cause a horizontal scrollbar).

\$\endgroup\$
4
\$\begingroup\$

Should code postings be anonymized?

\$\endgroup\$
  • \$\begingroup\$ I feel like there is already some anonymity in making an account -- but this is an interesting idea for people that have lots of information linked to their accounts. How do we do this feasibly? It seems like we'd have to change some basic mechanics of how the site works (but it might be a cool thing to change and not hard on the back-end .. just a checkbox that says "I'm anonymous for this question") ... naturally you can still get rep and stuff? Maybe only half of what you'd get otherwise? \$\endgroup\$ – sova Jan 19 '11 at 21:11
  • \$\begingroup\$ well actually I was referring to making sure we don't leak anything pertaining to our employers or clients \$\endgroup\$ – LRE Jan 19 '11 at 21:12
  • 4
    \$\begingroup\$ I would hope that wouldn't need to be specified in the FAQ \$\endgroup\$ – Joe Phillips Jan 19 '11 at 21:15
4
\$\begingroup\$

How we define duplicates, and how to search for possible answers before posting.

\$\endgroup\$
4
\$\begingroup\$

Should you continually (ever?) edit your post following suggestions from answers?

(Until you accept one?)

\$\endgroup\$
4
\$\begingroup\$

Suggestions on how to format your review. Stole the idea from TryPyPy. The conclusion to this question:

Poor man's inline comments: Should we suggest using these?

\$\endgroup\$
4
\$\begingroup\$
  • How is this site different from programmers.se

And clarification on:

If you are looking for specific feedback about…

  • Best practices and design pattern usage in your code

and your question is not about …

  • Tools, best practices, improving, or conducting code reviews

Best practices is both encouraged and discouraged?!?!?!?

\$\endgroup\$
3
\$\begingroup\$

The conclusion to this question:

Which answer to accept?

\$\endgroup\$
2
\$\begingroup\$

If my code contains errors, should I also provide the error codes that appear during compile/runtime?

\$\endgroup\$
  • \$\begingroup\$ I wonder if error-ed code is what this site is for. I suspect such code should go on StackOverflow. This site (IMO) is about improving code quality. \$\endgroup\$ – LRE Jan 19 '11 at 22:03
  • 1
    \$\begingroup\$ That would be Stackoverflow, Benchmarks are different and should be posted (if available). \$\endgroup\$ – RobertPitt Jan 19 '11 at 23:50
2
\$\begingroup\$

Code should be formatted to a certain standard.

If I am helping someone improve there programming the last thing I want to do is format it myself.

class MyClass
{
public function somemethodwithnameconvention(){
while(;;){
if(true){break
}
}
}
}

And what i would want to expect is:

class MyClass
{
    public function somemethodwithnameconvention()
    {
        while(;;)
        {
             if(true)
             {
                 break;
             }
        }
    }
}
\$\endgroup\$
  • \$\begingroup\$ Your brace style is ungodly you heathen! \$\endgroup\$ – LRE Jan 20 '11 at 7:03
  • \$\begingroup\$ please explain what you mean by your comment? \$\endgroup\$ – RobertPitt Jan 20 '11 at 8:15
  • \$\begingroup\$ @Robert - I was using a tongue-in-cheek reference to various "holy wars" among programmers regarding the placement of opening and closing braces to point out that the standards you refer to can't be too specific. \$\endgroup\$ – LRE Jan 20 '11 at 18:43
  • \$\begingroup\$ That was just example, what the main point is that code should be indented to a certain extent, I do not mean to be to specific but the there should be a reference in the FAQ to make sure all most at least have some requirements to indentation. \$\endgroup\$ – RobertPitt Jan 20 '11 at 20:34
  • \$\begingroup\$ I do agree @Robert that users should be expected to at least try to make code readable. Quite where the boundaries lie might be the subject of a question in it's own right. \$\endgroup\$ – LRE Jan 21 '11 at 4:04

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .