Working with git

Forking - branching - changing - pushing - PR

This is a general workflow in how to work on your own fork (copy) of the RSQKit repo and request changes through a pull request: NOTE: if you already did these steps in the past, start from the git fetch upstream command.

Make a fork of this repository, using the fork button.
Open a terminal and clone your fork using:
```
  git clone git@github.com:USERNAME/RSQKit .git
  cd RSQKit 
```
NOTE: Make sure you clone the fork and not the original EVERSE-ResearchSoftware/RSQKit one.

Keep your fork up to date (IMPORTANT!).

  git remote add upstream https://github.com/EVERSE-ResearchSoftware/RSQKit .git
  git fetch upstream
  git checkout master (if you are not already on the master branch, check with `git branch`)
  git pull upstream master

Create a new branch named after your feature/edit.
```
  git checkout -b 'FEATURE_NAME'
```
Make the changes you want to make using an editor of choice
Save.
Open terminal and stage your changes:
```
  git add .
```

Committing changes

  git commit -m "Changing the tool-resource file"

Pushing you changes to your fork
```
  git push origin 'FEATURE_NAME'
```
Go to https://github.com/EVERSE-ResearchSoftware/RSQKit and click on Compare & pull request
Open the pull request an describe your changes.
Wait for review by other editors. Editors that are responsible for the sections you make changes to will be assigned as reviewer automatically.

Credit

The contents of this page have been adapted from the “Working with git” page in the Research Data Management Kit (RDMKit).