User Story & Issue Naming Conventions - PelletierConstructionGroup/Pelletier-construction-group-nestjs GitHub Wiki
User Story Naming Convention
User Story Title
Developers will create and assign themselves with a user story with the title in the following format:
USER STORY: <Title of User Story>
Example:
USER STORY: Sign Up Page
To prevent duplicate user stories, developers should check the Kanban board and Miro sprint planning board before creating a user story to make sure the user story hasn't been claimed. Once that has been cleared, they should mark the corresponding user story on the Miro sprint planning board as claimed on a sticky note (with their name) and then create the user story on Github and assign themselves to it.
User Story Issue Title
Developers will create a new issue from their assigned user story using the following naming convention:
<Title of User Story>: <Title of Issue>
Example:
Sign Up Page: Add Confirm Password text field
User Story and Issue Labels
When creating a user story, developers should add the relevant labels, such as the current sprint and which project the user story is for (PelletierConstructionGroup.github.io). This is important so that the user story shows up on the Kanban board for the correct project.
After you create the user story, you will be able to change the status. Once you start the user story, mark it as “In progress”. This will make the user story show up in the correct section of Kanban board.
User Story Description Box
In the description box of the user story, make a task list which lists all of the small tasks that make up your user story. You can then link the issues you make for these tasks later and check them as complete as you go.
Issue Naming Convention
Single Issue Title (Leadership Team Permission Only)
Leadership Team and those with permission may need to create a single issue that relates to one of the categories below. They will adhere to the following naming convention:
feature: <Title of Issue>
bug: <Title of Issue>
refactor: <Title of Issue>
experiment: <Title of Issue>
documentation: <Title of Issue>
chore: <Title of Issue>