/All-Github-Guides

This repository contains all the guides to get started with our Exeter-Diabetes Github organisation! Everything from File naming, to Git, to workshops!

A guide on using this Github organization for any newcomers!

Why a Github organization?

  1. Github is an excellent version control and collaboration platform - allowing the Exeter Diabetes team to centralise their code in one place.
  2. Github allows you to create a stable branch of your code so that you have a permanent link to reference for Research papers, all the while working and updating your code in the same place!
  3. An organization can be managed more simply than having several independant github repositories, and it simplifies interacting with large singular repositories by breaking them down into more bite-size collaborations!

Guides

This repository consists of all the info you need to know in order to get started as a collaborator! Here is the recommended order to go through:

  1. Nomenclature.md
    • Acceptable naming format/style for repositories
    • Understand your way around the organizational repositories
  2. GitConfig.md
    • Step-by-step guide to correctly set up github on your device
    • Change and view git credentials
  3. Repositories.md
    • Setting up new Github repositories
    • Connecting local projects to Github repositories
  4. GitBash.md
    • Explains the core concepts of Git
    • Get comfortable with using Git in its native environment - shell
  5. R-StudioGit.md
    • Use Git without ever leaving R-Studio
    • Manage your commits, stages, and pushes/pulls without memorising the Git shell commands