Git Standards

New to git?

Branches

• master: This is the "polished" branch. Code should only be merged into this branch after it has passed the software acceptance test. The idea here is that, at any time, if we need fully-working code on the robot, we can just put the contents of master on.
• develop: This is the normal common development branch. Most of the time we should work out of develop, or out of a feature branch.
• feature/my_cool_feature: A feature branch. Make a new feature branch before starting work on a new feature. Commit all your work here, and push it every time you have a connection. Merge your feature into develop once you finish it.

If you want to learn more through an interactive tutorial try out this website: https://learngitbranching.js.org/

Commits

Make commit messages useful! A commit message should describe what changes are being added. Personally (Nick), I use a standard called Conventional Commits. The benefits behind conventional commits is the ability to auto generate changelogs which can be helpful! Not required but if you have questions feel free to ask!