Git Workflow

Branches

• The master branch contains the release version of the project.
• Work is done in the develop branch or an issue/feature branch off of develop.
• The gh-pages branch contains only the website resources i.e the landing page of the project

Workflow

Each developer will keep their own fork of the repository. To submit your contribution to the project, a pull request is raised. Pull requests will be merged into the development branch and once it's determined that the changes are stable and bug-free, the project manager will merge the development branch into the master.

• Work is done in the develop branch or an issue/feature branch off of develop
• When an issue/feature is complete, it is merged into the develop branch
• Committing to develop automatically runs the build on the CI tool
• After all tests pass and when the contribution is deemed ready, a pull request is created to merge develop into master
• The repository administrator handles the pull request and makes sure to also update related resources such as the wiki, documentation, issues, release notes, etc.