Skip to content

Git Workflow

Mario HDL edited this page Jul 20, 2018 · 6 revisions

1 Introduction

2 Creating your feature branch

Please follow this procedure:

1. Make sure you are starting off the latest develop code:

git checkout develop
git pull

2. Create your feature branch. The branch should be named issxxx where xxx stands for issue number #xxx against which you are entering your changes. If there is no issue on the list, please enter one and assign it to yourself.

git branch issxxx
git checkout issxxx

3. Make sure you updated the make script and that solution acutally builds:

cd $RVS
cmake . -B../build
cd ../build
make

4. Go back to your working folder and start working on your new feature.

3 Pull Request process

3.1 Before Pull Request

1. Stage and commit your work:

git add ...
git commit -m"#xxx - my new feature"

2. Get latest changes sine you branched-off your feature branch:

  • ALWAYS merge latest origin/develop changes before pushing your feature branch

  • NEVER merge from master branch as this will affect tagging and version numbering

Proceed like this:

git fetch --all
git merge origin/develop

3. Resolve any merge conflicts. If you noticed and new tags or any changes to CMakeLists.txt files (or anything that might affect make scripts in general), you must re-create make scripts:

cd $RVS
cmake . -B../build

Stage and comit your post-merge changes:

git add ...
git commit -m"#xxx - my new feature - after merge"

4. Push your feature branch onto origin:

git push --set-upstream origin iss_xxx_

3.2 Creating a Pull Request

1. Go the the RVS GitHub site and click "Code" -> "Branches".

2. Click "New pull request" button next to your iss_xxx_ branch

3. IMPORTANT adjust "base" and "compare" fields so that it reads: base: develop - compare: issxxx

3.3 Enter Pull request

3.4 Submitting Fixes

3.4 Merging

Clone this wiki locally