How to setup the development environment

Forking the repository#

Login to your bitbucket account
Navigate to N.I.N.A.'s main repository and click on the big plus
Click "Fork this repository"
You will see a configuration wizard for your fork.
Enter a name for your forked repository. (This guide will use "ninaexamplefork" for reference)
Give a short description what your intention is with this fork (optional)
Uncheck Issue tracking and Wiki as you don't need this in your fork.
Click on "Fork repository"
You will be navigated to your new repository at https://bitbucket.org/\<your_username>/\<your_fork's_name>/

Cloning Repository#

On the top right of your forked repository click on the "Clone" button
A pop up will show the command how to clone this repository to your local machine
Open a command window
Navigate to the folder where you want your repository folder to be created in

Enter the command that was shown in step 2.

git clone -n -b develop https://<YourUserName>@bitbucket.org/<YourUserName>/<YourForkName>.git
# NOTE: the -n flag for "don't checkout the branch"
# Ignore any LFS smudge errors for now. They are not yet synced and will get synced in a later step

Navigate to the created folder
```
cd <YourForkName>
```
Next you need to add the "upstream" to the root repository (where your fork is based on). This is later required for merging from the main dev branch etc.
```
git remote add upstream https://bitbucket.org/Isbeorn/nina.git
```
Bitbucket will not automatically copy over the LFS into the fork repository. This has to be done manually. Run the following commands to sync the lfs
```
git lfs fetch upstream --all
git lfs push origin --all
```
Now we need to checkout the develop branch
```
git checkout develop
```
Fetch the submodules for the external dependencies. These contain all third party vendor DLLs that are not part of any nuget package, e.g. Camera Drivers, VCRedist etc.
```
git submodule update --init --recursive
```

Keeping your repository up-to-date with the upstream root repository#

Open command line and navigate to your project folder
Fetch changes from the upstream repository
```
git fetch upstream
```
Merge incoming changes from the upstream develop branch into your develop branch
```
git merge upstream/develop
```
In case you run into unresolvable merge conflicts you have to solve these in your favorite merge tool