Skip to content

Instantly share code, notes, and snippets.

@sgnl

sgnl/BUG_REPORT.md

Last active August 17, 2021 21:25
Show Gist options
  • Save sgnl/1f16c09532d4d3c41b213c59b2914b9f to your computer and use it in GitHub Desktop.
Save sgnl/1f16c09532d4d3c41b213c59b2914b9f to your computer and use it in GitHub Desktop.
Download ZIP
Bug Report Format
Raw
BUG_REPORT.md

Bug Report format

Describe what is wrong?

some description that

Describe what is the expected behavior?

some description of good behavior!

Include a "Steps to Reproduce" section describe:

  1. Go to URL
  2. Do some steps
  3. Click something
  4. Notice the error!

Provide an "Additional Information" for such things as:

  • Browser
  • Operating System
  • Screenshot of current state
  • Video capture
  • Screenshot or mockup that best represents fix or best behavior
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment