Skip to content

Git Flow

Jump to bottom
Octavia Togami edited this page Feb 24, 2022 · 3 revisions

This page describes our Git and GitHub policy.

Here's how it works:

  1. master is the main branch. All code on master MUST compile AND pass tests. master may not be pushed to directly or have its history rewritten.
  2. Feature branches
    • Feature branches are named as follows: feature/<the-feature-you-are-adding>. Examples from our previous project: feature/DOCUMENT-EVERYTHING, feature/lidar, etc.
    • Feature branches are usually worked on by one or two developers. There's not many guidelines for them other than that.
    • When a feature branch is complete, propose it as a PR on GitHub. See this for more information.
  3. PRs
    • One developer MUST approve the PR before it is merged. This is enforced by GitHub.

 

Clone this wiki locally