-
Notifications
You must be signed in to change notification settings - Fork 1
Task Tracking via Issues
GitHub Issues is how we do our task tracking at the moment. They allow us to create a post for a task that needs doing, and for members to claim that task. They can also automatically be linked to Branches and Pull Requests for ease of development and submission.
You can find the Issues tab along the top bar in the GitHub repo underneath the repo name. It should be the second button.
Once you find the issues, there are are few important things to look at before determining whether you wish to work on it.
Each issue is marked with labels. These help you to properly sort through issues that fit you most.
- Draft: This means that an issue is currently being written, and isn't ready to be worked on yet.
- Approved: This means that the issue has passed the draft stage, and is ready to be worked on.
- Difficulty: This label is denoted by a capital D followed by a number. The higher the number, the more difficult the issue is estimated to be.
- Priority: This label is denoted by a capital P followed by a number. The higher the number, the more important/time sensitive the issue is.
- New Member: This means that the issue is particularly friendly to newer members. It doesn't require a lot of prior knowledge of the codebase.
The description gives an overview of what the task is and why it matters.
The implementation steps gives you a general order to do things in, and gives specific deliverables that allow you to know when the task is complete.
This is just an estimate of how long the task should take, or when it needs to be done by.
This is located at the right of the issue. It shows who, if anyone, is already assigned to an issue. You may not claim an already assigned issue unless the current assignee has agreed to let you join.
After you have found an issue to work on, it's time to claim it! There are only a few steps to claiming an issue.
- Make sure you have fully read through the description and implementation steps! These are an important guide to completing the issue.
- Notify the Project Manager of you selection. You do not have to wait for their confirmation to claim the issue, this notification is mostly just to help them keep track of things
- Assign yourself to the issue. You can do this by going to the Assignees section on the right and clicking
Assign yourself - Create a branch for the issue. You will be writing and committing all of your code within this branch. You can do this by going to the Development section on