rapids/docs/developers/git-flow.md

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

1. Pull the latest develop

git checkout develop
git pull

1. Create your feature branch

git checkout -b feature/feature1

1. Add, modify or delete the necessary files to add your new feature
2. Update the change log (docs/change-log.md)
3. 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

1. Integrate your new feature to develop

   === "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.
   
    ```bash
    git checkout feature/feature1
    git fetch origin develop
    git rebase -i 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.

    Push your feature branch online
    ```bash
    git push --set-upstream origin feature/external-test
    ```
    Then open a pull request to the `develop` branch using Github's GUI
   

Release a New Version

1. Pull the latest develop

git checkout develop
git pull

1. 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

1. Add new tag

git tag v[NEW_RELEASE]

1. 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]

1. Fast-forward master

git checkout master
git merge --ff-only develop
git push

1. Go to GitHub and create a new release based on the newest tag v[NEW_RELEASE] (remember to add the change log)

Release a Hotfix

1. Pull the latest master

git checkout master
git pull

1. 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

1. Fix whatever needs to be fixed
2. Update the change log
3. 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]

1. Fast-forward master

git checkout master
git merge --ff-only v[NEW_HOTFIX]
git push

1. Go to GitHub and create a new release based on the newest tag v[NEW_HOTFIX] (remember to add the change log)