Most bug readers will agree, a simple “Expected Results” vs. “Actual Results” statement in the bug description will remove all ambiguity. But what about the bug title? Is a bug title supposed to include the expected results, actual results, or both? Every time I log a bug, I pause to consider the various title possibilities. I want a unique but concise title that will summarize the bug, making the description as unnecessary as possible. My head swims with choices…
- If user does X after midnight, user gets Y.
- If user does X after midnight, user should not get Y.
- If user does X after midnight, user should get Z.
- If user does X after midnight, user gets Y instead of ZUser should get Z when they do X after midnight.
Here is what I think.
There is no “best” bug title. Any bug title is good enough as long as it:
- is unique within my bug tracking system
- describes the problem to some extent
- includes key words (these words will be used someday to find this bug; searching for bugs where title contains some text)
So unless someone convinces me otherwise, with a comment on this post, I have decided to just use the first distinct bug title popping into my mind and stop worrying about bug title perfection.