BugSquad/Bug Report: Difference between revisions

Mchua (talk | contribs)
Mchua (talk | contribs)
Line 23: Line 23:
[[Image:Blank-ticket.png]]
[[Image:Blank-ticket.png]]


=== Create a title for the ticket ===
=== Create a summary for the ticket ===
 
You'll notice that the first text box is for a '''Summary''' of the ticket. Sometimes the '''Summary''' is also called the '''Title''' of the ticket. This is an important part of the ticket - in fact, some people say it is the ''most'' important part - because reading the title of a ticket is how a developer decides that he or she is going to work on it.
 
Write a ticket summary/title that describes your idea. Try to write it so that a developer reading the title of your ticket will go "oh, I know what I have to work on, and why this is important - I will read more about this ticket and maybe try to fix it."
 
A good ticket is in many ways like a good newspaper headline.
 
'''Good newspaper headlines:''' (taken from http://lwn.net/ as of the day of this writing)
 
* SpamAssassin-milter has a remote root vulnerability
* SeaMonkey 1.x goes unsupported
* GNOME Foundation and KDE e.V. to Co-Host Conferences in 2011
 
'''Bad newspaper headlines:'''
 
* Today, bad things happened with SpamAssassin
* Stuff about SeaMonkey
* GNOME and KDE are doing a thing
 
Similarly...
 
'''Good ticket titles:''' (taken from http://dev.sugarlabs.org as of the day of this writing)
 
* Frame: Battery icon does not update when battery is removed/replaced
* Make "keep aspect ratio" selection visible in the UI
* Drop down menus give no indication of their existence, also are too slow to load.
 
'''Bad ticket titles:'''
 
* This frame stuff doesn't work
* Make the Paint Activity better
* HELP I have a problem!!!


=== Describe the ticket ===
=== Describe the ticket ===