Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 2.45 KB

code_collaboration.rst

File metadata and controls

67 lines (49 loc) · 2.45 KB
Raw

Code Collaboration

This section describes the use of Git and Github in relation to standard Tudat developer use cases. This chapter does not serve as a complete tutorial on Git, but rather as an extension to the workflow used by Tudat Space.

users Mission Brief

^^^ .. table:: :widths: 20 60 10

Audience Prerequisite(s) Time
Git Beginner ~ 10 minutes

Note

Using Conda? Git comes with the Anaconda and Miniconda distributions by default. If you are using Conda, the setup step can be skipped in the guide.

graduation-cap Learning Objective(s)

^^^

  1. Understand the differences between Git and Github.
  2. Installing and configuring Git for use.
  3. Create, clone and manage repositories from Github.
  4. Understand the Tudat Git workflow.

Develop and Master Branches

Instead of a single master branch, this workflow uses two branches to record the history of the project. The master branch stores the official release history, and the develop branch serves as an integration branch for features. It's also convenient to tag all commits in the master branch with a version number. :citeatlassian-gitflow

Feature Branches

Each new feature should reside in its own branch, which can be pushed to the central repository for backup/collaboration. But, instead of branching off of master, feature branches use develop as their parent branch. When a feature is complete, it gets merged back into develop. Features should never interact directly with master. :citeatlassian-gitflow