this post was submitted on 14 Jun 2023
15 points (100.0% liked)

Learn Programming

1626 readers
1 users here now

Posting Etiquette

  1. Ask the main part of your question in the title. This should be concise but informative.

  2. Provide everything up front. Don't make people fish for more details in the comments. Provide background information and examples.

  3. Be present for follow up questions. Don't ask for help and run away. Stick around to answer questions and provide more details.

  4. Ask about the problem you're trying to solve. Don't focus too much on debugging your exact solution, as you may be going down the wrong path. Include as much information as you can about what you ultimately are trying to achieve. See more on this here: https://xyproblem.info/

Icon base by Delapouite under CC BY 3.0 with modifications to add a gradient

founded 1 year ago
MODERATORS
 

If people are going to post questions with code samples in this forum, I think we need to maybe address some basic underlying requirements. Personally, I prefer a loose moderation wherein we try to ensure a few basic quality of life requirements in posts:

  • Try not to provide screenshots of code since that's harder to review
  • If you need help debugging, please try to only provide the bare minimum portions of your code which are relevant
  • If possible, try to provide a runnable example of your code in question
  • Try to explain: what you've tried, what the error is, what you think the problem is

I'm not trying to sound pushy about forum etiquette. But I personally am much more likely to review code that meets the above requirements. I like something I can compile and run quickly. I prefer some context as to where the issue probably is. Everything else is sort of secondary to me, but still matters.

What does the community think? Also, what do we want this community to do? Support specific programming questions or general CS career/education questions? Both?

you are viewing a single comment's thread
view the rest of the comments
[โ€“] forbiddenvoid 1 points 1 year ago (1 children)

I think these seem reasonable, to start. I do prefer not having to type out code myself. It would make sense also, to provide some guidelines for people about how to format code as well.

Might also be worth generating some guidelines for people responding to questions and posts. A quick way to turn someone off of programming is to answer or respond to a question in a way that makes them feel unwelcome or dismissed.

[โ€“] [email protected] 2 points 1 year ago

True. Typing out code should be as simple as copy/paste inside two lines of three "backticks" (backtick: `)

E.g.

``` My code ```

My code