Skip to content

Instantly share code, notes, and snippets.

@sumitngupta
Last active August 29, 2015 14:05
Show Gist options
  • Save sumitngupta/4829da8e07b5a0780751 to your computer and use it in GitHub Desktop.
Save sumitngupta/4829da8e07b5a0780751 to your computer and use it in GitHub Desktop.

WRITING A GOOD BUG REPORT

  • Summary
  • Description
  • Steps to Reproduce
  • Actual Results
  • Expected Results
  • Reduced Test Case
  • Version, Platform and OS
  • Crash data and/or Screenshot

SUMMARY

Be precise:

  • Explain the bug in clear and specific terms.
  • Prepend "[REG]" to the summary for a regression bug.

Bad:

  • "Drag Crash" ####Good:
  • "Drag-selecting any page crashes Mac builds in NSGetFactory"

DESCRIPTION/OVERVIEW

Goal:

  • Explain the bug to the developer with a more detailed explanation.

Tips:

  • State the problem behavior.
  • Be as specific as possible.

DESCRIPTION/OVERVIEW Goal: Explain the bug to the developer with a more detailed explanation. Tips: State the problem behavior. Be as specific as possible.

STEPS TO REPRODUCE Steps: Identify the simplest steps needed to reproduce the bug. Simple case: Load the attached test case in Browser XYZ Complex case: Load the attached test case in Browser XYZ Scroll to the bottom of the page Click the link Press tab to navigate links

RESULTS Goal: Show developer what is wrong. Actual Results: Describe what actually happened. Expected Results: Describe what should have happened.

ENVIRONMENT VERSION, PLATFORM AND OS Select the software version, the platform and the OS version that this bug occurred on.

ADDITIONAL INFORMATION Crash data (backtrace), Screenshot, ...

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