Development

⚠️ Under Construction

---

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 (recommended). 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 🕥 ..... 🏭, .... let your inspirations out ...... 🎭 ...... 🕚 ..... 😵 ...... 🕐 ...... 😪.

2. Share with the world

   git push origin topic-branch
   

Then, make a pull request and make sure to choose develop as the base branch and your topic-branch as the compare branch.