Developer’s Guide

Description of Branches

main

This is the parent branch which consolidates the current development in the repository.

release-vX.Y.Z

These represent stable release branches. Users should always check out the most recent stable release branch when cloning the repository.

How to incorporate updates to CATChem

In order to contribute code to CATChem, you will need to fork the repository, make changes on your fork, and submit a pull request with your changes.

  1. Fork the GitHub repository to your own GitHub account using the “Fork” button near the top right:

    https://github.com/ufs-community/CATChem

    Note

    You can pull updates from the main repository by using the “Fetch Upstream” button on your fork. Alternatively: [1]

    $ git remote add upstream git@github.com:ufs-community/CATChem.git
$ git pull upstream main
$ git push origin main

  2. Navigate on your working machine to where you would like to keep the CATChem code (e.g. in your work location) and clone [1] your fork:

    $ git clone git@github.com:$GitHubUsername/$ForkName.git

  3. Checkout the develop branch — you need to do this with the remote branch as well as create a local tracking branch:

    $ git checkout origin/develop
$ git checkout develop

  4. Make changes to your fork.

  5. Submit a pull request back to the main CATChem repository with your changes.

  6. Select two code reviewers (see list under development team section).

  7. Once those two reviewers approve the code, it can be merged into the develop branch.