Skip to content

Instantly share code, notes, and snippets.

@yjkogan

yjkogan/asking_for_help_template.md

Last active April 13, 2021 20:55
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save yjkogan/0ead31ac1f3b6ff3d25382ae637d19be to your computer and use it in GitHub Desktop.
Save yjkogan/0ead31ac1f3b6ff3d25382ae637d19be to your computer and use it in GitHub Desktop.
Download ZIP
Asking for help can be scary! Here's a template I use.
Raw
asking_for_help_template.md

Asking for help can be scary! It can be really uncomfortable to admit you're stuck or that you don't know something. I've noticed this in myself and also had numerous conversations with colleagues who are anxious about requesting assistance. This is the format I use to unstick myself from those feelings. Every section is optional so you can of course omit it!

Hey everyone,

[Brief summary of what you're stuck on.]
[Context about what you're working on]
[What you expect to see and what you actually see]
[What you've tried so far. If relevant, include links to stackoverflow or github issues]

If you're on Slack or a tool like that and it seems like there's too much content for one message, you might conisder using a thread, or opening a ticket in your issue tracking system with the repro steps that you can link to.

This article also lays out "how to ask for help" in a helpful way with a lot of context: https://fredhutch.github.io/coop/community/asking-for-help/.

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