Skip to content
This repository has been archived by the owner on Jan 14, 2025. It is now read-only.

Issue Naming Convention

ogarmela edited this page Nov 11, 2024 · 3 revisions

Issue Naming Convention

Issue Categories

You can create a single issue that relates to one of the categories below and use 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>

Issue Labels

When creating an issue, developers should add the relevant labels, such as the current sprint and which project the issue is for (Belinda’s Closet or NSC Events). This is important so that the issue shows up on the Kanban board for the correct project.

Screenshot 2024-01-11 213321

After you create the issue, you will be able to change the status. Once you start the issue, mark it as “In progress”. This will make the issue show up in the correct section of Kanban board.

Screenshot 2024-01-11 214030

Issue Description Box

In the description box of the issue, you can make a task list that lists all of the small tasks that make up your issue. You can then check them as complete as you go.

image