Skip to content

Git Structure and Organization

James Butler edited this page May 12, 2022 · 2 revisions

Git Structure


  • The structure of the repository is monorepo.

Branching Strategy


  • The branching strategy that we are using in this repository is GitHub Flow.
  • This strategy uses a single continuous development branch which will always contain a working version of the project. This branch is called develop.
  • Feature branches will be made for changes and to the repository and these will be merged into the develop branch and subsequently deleted.
  • The default branch, main, will contain a stable version of the code in develop.
  • Forking will not be required. This is due to 'Hyperperform' not recognizing commits to forks.

Git Organization and management


  • Pull requests will be made from feature branches to the develop branch. After large features are added to develop or prior to a demo, develop will be merged into main via a pull request.
  • Each pull request will require at least one review and must pass all checks to be merged.
  • Pull requests to main will require at least 2 reviews before merging.
Clone this wiki locally