This page describes how to use GIT in unison with Jira. It also describes what code you can push to which repository and why some branches might be locked.
Commit rules:
Please adhere to the following template when making a commit.
Commit Title (-m flag): [Jira Task Id] Short description please, feel free to add emoji sparkles if that makes you happy ✨.
Commit Body: Very long description describing whatever you had for breakfast that day, why you changed this code and any other nonsense you feel like adding.
Why can't I push to Master?
In this project you'll only be able to push to staging, to get your feature to master please make a pull request, then your peers can review it and either accept it or request changes.
This safeguards master from accidental breaking changes and allows other groups, who might depend on your API, to work on their stuff instead of fixing yours.
Branches
Master
The master branch will be protected and no one will be allowed to push to it. The only way to get your feature to master (as described inWhy can't I push to master?) is through a pull request.
Requirements to get a pull request accepted into master:
Full Jira Task Completed (Not subtask)
Sphinx Docstrings
Unit Tests
Staging
The staging branch will be unprotected so you are allowed to push code directly to it, however please add the following out of courtesy for your fellow students.