Git Flow¶

We use the develop/master variation of the OneFlow git flow

Add New Features¶

We use feature (topic) branches to implement new features

Internal Developer

You are an internal developer if you have writing permissions to the repository.

Most feature branches are never pushed to the repo, only do so if you expect that its development will take days (to avoid losing your work if you computer is damaged). Otherwise follow the following instructions to locally rebase your feature branch into develop and push those rebased changes online.

Starting your feature branch

Pull the latest develop
```
git checkout develop
git pull
```
Create your feature branch
```
git checkout -b feature/feature1
```
Add, modify or delete the necessary files to add your new feature
Update the change log (docs/change-log.md)

Stage and commit your changes using VS Code git GUI or the following commands

git add modified-file1 modified-file2
git commit -m "Add my new feature" # use a concise description

Merging back your feature branch

If your changes took time to be implemented it is possible that there are new commits in our develop branch, so we need to rebase your feature branch.

Fetch the latest changes to develop
```
git fetch origin develop
```

Rebase your feature branch

git checkout feature/feature1
git rebase -i develop

Integrate your new feature to develop

git checkout develop
git merge --no-ff feature/feature1 # (use the default merge message)
git push origin develop
git branch -d feature/feature1

External Developer

You are an external developer if you do NOT have writing permissions to the repository.

Starting your feature branch

Fork and clone our repository on Github
Switch to the latest develop
```
git checkout develop
```
Create your feature branch
```
git checkout -b feature/external-test
```
Add, modify or delete the necessary files to add your new feature

Stage and commit your changes using VS Code git GUI or the following commands

git add modified-file1 modified-file2
git commit -m "Add my new feature" # use a concise description

Merging back your feature branch

If your changes took time to be implemented, it is possible that there are new commits in our develop branch, so we need to rebase your feature branch.

Add our repo as another remote

git remote add upstream https://github.com/carissalow/rapids/

Fetch the latest changes to develop
```
git fetch upstream develop 
```

Rebase your feature branch

git checkout feature/external-test
git rebase -i develop

Push your feature branch online

git push --set-upstream origin feature/external-test

Open a pull request to the develop branch using Github’s GUI

Release a New Version¶

Pull the latest develop
```
git checkout develop
git pull
```

Create a new release branch

git describe --abbrev=0 --tags # Bump the release (0.1.0 to 0.2.0 => NEW_HOTFIX)
git checkout -b release/v[NEW_RELEASE] develop

Add new tag
```
git tag v[NEW_RELEASE]
```

Merge and push the release branch

git checkout develop
git merge release/v[NEW_RELEASE]
git push --tags origin develop
git branch -d release/v[NEW_RELEASE]

Fast-forward master

git checkout master
git merge --ff-only develop
git push # Unlock the master branch before merging

Release happens automatically after passing the tests

Release a Hotfix¶

Pull the latest master
```
git checkout master
git pull
```

Start a hotfix branch

git describe --abbrev=0 --tags # Bump the hotfix (0.1.0 to 0.1.1 => NEW_HOTFIX)
git checkout -b hotfix/v[NEW_HOTFIX] master

Fix whatever needs to be fixed
Update the change log

Tag and merge the hotfix

git tag v[NEW_HOTFIX]
git checkout develop
git merge hotfix/v[NEW_HOTFIX]
git push --tags origin develop
git branch -d hotfix/v[NEW_HOTFIX]

Fast-forward master

git checkout master
git merge --ff-only v[NEW_HOTFIX]
git push # Unlock the master branch before merging

Release happens automatically after passing the tests