Github Overall Structure

This wiki page is a high-level summary of our Github structure. This assumes you already have some basic knowledge of how Github operates.

Whenever you make a new feature it should be on its own branch. For example, let's say you are in charge of creating a new feature called 'identify lanes'. You would then create a new branch from master (git checkout -b <new-branch> master) (Note: make sure your local version of master is up-to-date first). You would then continue to make changes and commit on your feature branch. Then, once you have fully completed that feature (including running test cases, etc) you would create a pull request (PR) for that branch to be merged into master. At that point, someone will review your code and make suggestions or approve it. All code must be reviewed before being pulled into master.

Some notes:

• Always make sure your master (or whatever base branch) is up-to-date before making changes. I recommend always running git pull origin <branch-name> before doing anything else. It will save headaches further down the line.
• Never push directly to master, it should be a pristine beautiful place with only working, happy code.
• The above doesn't deal with hotfixes and bugs possibly missed in master. These 'hotfix' bugs will be fixed in separate branches from the original feature branch.

There is a much more detailed version of this wiki which can be found here.