(1min 30 read time)

When creating an Issue or a PR (Pull Request), ensure you provide as much information as possible from the outset. The most important to be added as follows:

• Source: The origin of the task (e.g., project, ticket, etc.).
• Week: The sprint or time period the task is associated with.
• Development: Specifically when you raise a PR, link it to the relevant issue(s).

If you are raising a PR, copy the Source and Week from the related issue.

<aside> 💡

For more details on the different parts of a task see:

Task Structure

</aside>

Immediate Work

If you plan to start working on the task immediately and it does not have an issue, follow these steps:

• Assign it to the current Week.
• Set the status to "In Progress".

This ensures the task is visible and properly represented, especially if it will take considerable time to progress.

When to Create a Issue

Issues will mostly be created during stand-ups, project kick-off meetings, but can also be made as and when required by any team member. Use the following guidelines to determine if an issue needs to be created:

• Time Requirement: If the task will take more than 1 hour to complete, create an issue.
• Creation of New Work: If the task requires you to create something, such as writing code, making more tasks, or creating documentation, an issue should be created.

When Not to Create an Issue

• Investigations: You do not need to create an issue for ongoing investigations resulting from a support ticket. This is the scoping phase and is not an considered actionable task yet.
• Short Tasks: If a task will take less than an hour to complete, and/or you expect to raise a PR within that time, there is no need to create an issue.