This page describes how to set up the doc team's source control, git, onto your laptop.
Edit me
Git Bash Set Up
- Install Git Bash by downloading from here: https://git-scm.com/
- Follow these steps to set up Git Bash for the first time: https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup
Clone BackOffice/dsp-docs repo to local
Prior to doing any work, you need to obtain a copy of the BackOfficeAssoc dsp-docs repository for your local computer.
To clone the BOA dsp-docs repo to your laptop:
- In GitHub, go to the BackOfficeAssoc account.
- Find the BackOfficeAssoc/dsp-docs repo.
- In the BackOfficeAssoc/dsp-docs repo, click the Clone or download button. Once you click it, it will reveal a URL that you need to copy and paste into your command line in the next step. Click the copy to clipboard button to the right of the url to copy it.
Note: There are various options for cloning. We will be doing the clone from the command line, so simply copy the SSH URL shown.
- Open Git Bash and navigate to the directory that you wish to download to.
Note: The repository will be cloned into a new directory below the one you specify, with the same name as the repository, ex.
C:\\heathercloward\\github\\dsp-docs
.Tip: Alternatively, in Windows Explorer, you can right-click in a folder and select Git Bash Here from the dropdown menu to open the command prompt at that location. - Run the git clone command using the SSH URL from step 3.
Note: It should look like:
git clone git@github.com:BackOfficeAssoc/dsp-docs.git
. - Switch into your new directory by entering the git command
cd dsp-docs
Note: You will know you are in the correct directory by the command prompt, ex.Documents/GitHub/dsp-docs (develop)
shows repo name and branch name. - Fetch the develop branch so that you have it in your local repo by entering the git command
git fetch origin develop
.Note: Any branch you do not have on your local that exists on the remote can be created in this way.Important: All release branches should be based on the develop branch.