Code - GorgonCryoEM/Gorgon GitHub Wiki

Getting Started

Gorgon project is maintained under version control, Git, and is hosted on GitHub. In order to contribute to Gorgon development or to be added as a team member or outside collaborator, you will need a GitHub account.

  1. GitHub account setup.
  • Get a GitHub account.
  • Upload your SSH public key to your GitHub account. More details here and here.
  1. Get the code.
  2. Clone. * Via ssh: git clone --recursive [email protected]:GorgonCryoEM/Gorgon.git or * Via https: git clone --recursive https://github.com/GorgonCryoEM/Gorgon.git
  3. Update.
```
git fetch
git pull
git submodule update --init
```
  1. Setup branches.

  • Checkout and track branch develop.

    git checkout -t origin/develop

  • Always branch off develop. Use an appropriate name for topic-branch.

    git checkout -b topic-branch develop

  1. Do some work :clock1030: ..... :factory:, .... let your inspirations out ...... :performing_arts: ...... :clock11: ..... :dizzy_face: ...... :clock1: ...... :sleepy:.

  2. Share with the world, more details.

    git push origin topic-branch

  3. Make a pull request.

  • Choose develop as the base branch.
  • Choose your topic-branch as the compare branch.
  1. More help...

Contribution After Initial Setup

  1. Update develop branch, assuming it exists.

    git checkout develop
git fetch
git pull

  2. Branch off develop. Use an appropriate name for topic-branch.

    git checkout -b topic-branch develop

  3. Do some work.

  4. Push your changes.

    git push origin topic-branch

  5. Make a pull request.

  • Choose develop as the base branch.
  • Choose your topic-branch as the compare branch.

Some resources on GitHub: