Skip to content

Instantly share code, notes, and snippets.

@mmeigooni
Last active February 2, 2017 18:28
Show Gist options
  • Save mmeigooni/fe00616da9bb13b0363f73a3ea09d37c to your computer and use it in GitHub Desktop.
Save mmeigooni/fe00616da9bb13b0363f73a3ea09d37c to your computer and use it in GitHub Desktop.

How do I ask a good question?

We’d love to help you. To improve your chances of getting an answer, here are some tips:

Do some research

... and keep track of what you did. Even if you don't find a useful answer, including links to documentation or similar questions that gave you a clue can help us understand your approach.

Write a title that summarizes the specific problem

The title is the first thing we see and will set the tone for everything that comes after. So make it count.

  • Pretend you're talking to a busy colleague and have to sum up your entire question in one sentence: what details can you include that will help someone identify and solve your problem?
  • Spelling, grammar and punctuation are important!
  • If you're having trouble summarizing the problem, write the title last - sometimes writing the rest of the question first can make it easier to describe the problem.

Examples:

  • Bad: Broken loop
  • Good: My counter variable isn't incrementing during a while loop
  • Bad: if else problems
  • Good: Why does arr === ["Hello World!"] evaluate to false when arr is set to ["Hello World!"]?

Introduce the problem

In the body of your question, start by expanding on the summary you put in the title. Explain how you encountered the problem you're trying to solve, and any difficulties that have prevented you from solving it yourself.

Include some code (if necessary)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment