branching_workflow.md

Mailbagit Branching Workflow

Find an Issue

• Review the project
• Select an issue
• Identify the Issue number

Viewing Branches

• View local branches

git branch

• View local and remote branches

git branch -a

Creating a new feature to address the issue

1. Move the issue to "in progress" in the project
2. Create a new branch named feature-[issue number]

git checkout -b feature-[issue number]

3. Edit the branch locally
4. Run local tests

black .
pytest

5. Push branch to remote

git push origin feature-[issue number]

6. Create a Pull Request from your branch to develop
7. Move the Issue in the project to "Ready for Review"

Reviewing

1. View the "Ready for Review" column in the project and identify the issue number
2. View the original issue and the pull request
3. Checkout the

git fetch
git checkout feature-[issue number]

4. Review the code and ensure it effectively addresses the issue
5. Run local tests

black .
pytest

6. Merge the branch to develop

git checkout develop
git merge feature-[issue number]

7. Move Move the Issue in the project to "Reviewer Approved"