Writing issues

When filing issues, keep the title short and the body descriptive.

Titles

Keep the title short.
Put any details in the body, not in the title. This makes it easier to digest a long list of issues.

When I try to change passwords, an error is raised. ✗ ...can be shorter
[User] can't change passwords ✗ ...put that in the description
Can't change passwords 👍
Don't be too general.
Try to be more specific when possible.

Products error ✗ ...too broad
Can't buy products ✗ ...still too broad
Product page error ✗ ...still too broad
Product page: the buy button isn't clickable 👍

Write a short description.
Add a one-sentence (or one-paragraph) in the body of the issue.

Title: Can't change passwords
Description: When I'm logged into as a User, the "change email" form returns an error.
Be visual.
Include screenshots when possible!
Be detailed.
For bug reports, ensure that the following details are available or are obvious:
- URL (if applicable)
- Environment (OS, browser, website environment)
- Steps to reproduce
- Expected result
- Actual result
But not too detailed.
You don't need to actually list all of them (especially for simple issues), just make sure that anyone can figure those details out.

No need to include steps/expected/actual when it's obvious.

Avatars are not shown
The user directory is missing avatars. (OS X, Firefox, Production)
http://ticketadvisor.com/users

[screenshot goes here]

Can't send email
The "send email" button isn't clickable.
Environment: OS X, Firefox, Production.
http://ticketadvisor.com/user/23/edit

[screenshot goes here]

Steps:

Expected: The email will be sent.
Actual: A JavaScript error appears when "send" is clicked.