Issue Title Naming

User Story Titles

A user story defines a behavior or feature that a solution must implement to meet user needs. The recommended formats for user story titles are:

1. As <a persona/type of user>, I want <something> so that <some reason>
   Example: As Sam Spendsalot, I want one-click purchase so that I can get my goods as quickly as possible.

2. As a <persona/type of user>, I want <something>
   Example: As a User, I want to create a task.

3. <persona/type of user> <performs action on> <thing>
   Example: User visits home page OR User creates a task.

These formats are based on Microsoft’s MSDN, which credits Mike Cohn at Mountain Goat Software.

Example of Removing a Feature

Example: As the product owner of product X, I want feature Y to be removed so that our UI is more streamlined and only provides features that are genuinely useful to our customers.

Bug Titles

A bug is a defect that impairs a product or service’s functionality. The recommended formats for bug titles are:

1. <person/type of user> can’t <perform action/get result>
   Example: New User can’t view home screen.

2. When <performing some action/event occurs>, the <system feature> doesn’t work

3. When <persona/type of user> <performs some action>, the <system feature> doesn’t work

4. <system feature> doesn’t work

5. <system feature> should <expected behavior> but doesn’t

6. <system feature> <is not/does not> <expected behavior>

7. <persona/user type> <gets result> but should <get different result>

8. <quick name>. <one of the formats above>
   Example: “Broken button. New User can’t click the Next button on Step 2 of the Wizard.”

These formats are based on an analysis of close to 5,000 tasks across different organizations, projects, and teams.

Task Titles

Tasks refer to activities that need to be performed but do not fall into other categories like user stories or bugs. The recommended formats for task titles are:

1. <verb/action> <activity>
   Example: Perform backup.

2. <verb/action> <thing>
   Example: Research new JavaScript framework.

These formats are derived from the analysis of real-world data.

New Feature Titles

New feature tasks are used mainly for services or components that are somewhat removed from the end user, such as API endpoints. The recommended formats for new feature titles are:

1. Implement <endpoint>
   Example: Implement POST /api/v1/users.

2. Create endpoint <endpoint>
   Example: Create endpoint POST /api/v1/users.

Improvement Titles

Improvement tasks involve minor modifications to existing functionality. The recommended formats for improvement titles are:

1. <endpoint> > also <additional functionality>
   Example: POST /api/v1/users > also accept date of birth.

2. <component> > also <additional functionality>

3. Make <feature> run faster

4. Improve the performance of <feature/screen/endpoint>

5. Update <feature> <with/to> <update>

6. Rename <feature/text> to <new name>