Skip to content

GitHub Workflow Overview

Eric Swanson edited this page Apr 7, 2022 · 1 revision

he structure for each repository follows a model similar to that of GitHub flow (https://guides.github.com/introduction/flow/), with some alterations.

github workflow overview

The GitHub workflow is as follows:

  1. The workflow starts with a branch. When a developer would like to add a new feature or fix a bug, they make a new branch to develop the feature/bugfix.
  2. On this branch, developers make changes to the code and add their commits to the branch.
  3. Once the developer(s) feel the branch is ready to be merged, they submit a pull request.
  4. Once the pull request has been submitted, other developers (and repository owners and admin when merging into the master branch) should review and discuss the code. Testing should be done to verify that the code causes no issues with the existing code in the parent branch. If necessary, the developers should make revisions using the feedback from the discussion.
  5. Once the code is verified, the pull request is approved and the child (current) branch is merged with the parent branch.
  6. Repeat for every new branch
Clone this wiki locally