Skip to content

Instantly share code, notes, and snippets.

@guykisel

guykisel/help.md

Last active August 29, 2015 14:12
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save guykisel/0c0eee160c2682dc5cd3 to your computer and use it in GitHub Desktop.
Save guykisel/0c0eee160c2682dc5cd3 to your computer and use it in GitHub Desktop.
Download ZIP
help template
Raw
help.md

So you want to ask for help? Fill in this template. It'll save us all a lot of time.

Short summary of the problem

What are you doing? What's going wrong? Why do you need help? Keep this short and simple.

What's your best guess of what's causing the problem?

If you haven't already, take a moment to think about this. Do you have any ideas?

What have you tried so far?

Did you make any attempts at fixing this on your own? What are the steps you've tried?

What google search terms have you tried?

Just list the searches you've tried so far so that I know what you've looked for.

Logs and error messages

Can you provide a link to a log file? Is there a stack trace? Is there an error message?

Relevant documentation

Are there any docs related to this problem or the general context?

How important is this?

Do you need help right away? Can it wait?

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