Skip to content

Instantly share code, notes, and snippets.

@mattleff
Created July 19, 2011 21:36
Show Gist options
  • Save mattleff/1093785 to your computer and use it in GitHub Desktop.
Save mattleff/1093785 to your computer and use it in GitHub Desktop.
The Cardinal Sins of SU Bug Reporting

7 Mortal Sins

  1. Multiple issues in the same ticket
  2. Insufficient vetting of ticket
  • Is duplicable is not a yes/no but a prerequisite(?)
  • What exactly do you have to do to reproduce the issue?
  1. Incorrect/non-descriptive names
  • "no creation date"
  • "Shopping cart (transaction.php) is not charging the correct amount in FF 5.0 and IE 8.0+"
    • No need to mention the browsers unless it is a unique issue with a particular browser, which you should check
  • "AR RSS"
  • "Fatal error | misda.net" – Should be like "Fatal error on upload in file management"
  1. Resubmitting the same issue to increase visibility
  • A comment is good
  • Do search for previous reports of the issue
  1. Reopening a ticket for a different issue
  2. Superfluous and annoying verbiage
  • "Here's the issue"
  • "HELP!!!" – Double sin: ALL CAPS AND MULTIPLE PUNCTUATION!!!
  • "Thanks!"
  • Quoting a customer's email – We just want the gist
  1. Invoking emotions
  • "I feel terrible"
  • "HELP!!!"
  • We are programmers not therapists, and programmers are known for the cold, uncaring attitudes. :P

7 Virtues

  1. Quote errors and code with backticks:
    ```
    Really, really long error messages...
    ```
  2. List affected site(s) in the ticket description

Points of Understanding

  • All issues are important
  • Not all issues are urgent
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment