Github Workflow

Git Workflow

Note: This workflow assumes you have already setup the environment (docker) onto your machine.

Overview

This repository requires a pull request before any work can be merged into the main branch. The goal is to keep individual tasks isolated, making collaboration easier and changes easier to review.

Before writing any code, assign yourself an issue from the GitHub Issues tab. Each issue represents a single task. Work on one task at a time and see it through to completion before picking up something new — this keeps branches focused and pull requests straightforward to review.

Step-by-Step Workflow

1. Assign yourself a task from the GitHub Issues tab and create a new branch on your local machine for that task.
2. Commit your work regularly as you make progress — don't wait until the task is fully done.
3. When the task is complete, push your branch to GitHub.
4. Open a pull request for your branch.
5. Once a teammate has approved your pull request, merge the branch into main.

Only start a new task after your current branch has been merged. Keeping tasks isolated to their own branches prevents conflicts and makes it much easier for others to review your work.

Automated Checks

When you open a pull request, a GitHub Action will automatically run to verify two things:

• The repository builds successfully with your changes.
• All existing tests pass. If either of these checks fails, the pull request cannot be merged until the issue is resolved. Make sure to review the action output if this happens, as it will point to exactly what needs to be fixed.