Skip to content

Contribution Workflow

Jump to bottom
jonathanleek edited this page Oct 6, 2019 · 2 revisions

We're following a CI/CD structure for the use of this project. At the heart of our workflow are 3 primary branches:

  • Master is considered the canonical version of the project. If you are merely interested in running our code to get a result, this is where you should look.
  • Release is the branch for changes that have been approved, and are awaiting merge into Master.
  • Development is a dedicated copy of Master that is used to start new branches for issues.

When addressing an Issue from our list, you should start by creating a new branch off Development named for that issues (i.e. Issue_57). Do your work in that branch, and when you think you've addressed the issue, commit your change to that branch and create a pull request to merge it into Release. Once that pull request has been reviewed by one of the project leads, you can pull it into Release. At regular intervals, we will pull and merge Release into Master in order to create a new canonical version, and then pull and merge Master into Development so that the Development branch stays in sync.

Our Process for moving stuff through Github

Clone this wiki locally