Github Feature Workflow

GIT.md

Developer contributions:

In order to contribute to this repository, we are following the Github pull request workflow.

1. Update your local repository to the newest commit, execute:

git pull

2. Create a new branch based on a feature and switch to it using:

git checkout -b feature_x

3. Verify in your terminal you are currently on the new branch using:

git branch

4. Make your changes to the codebase, when ready begin committing and pushing

git add .
git commit -m "i made some changes to x"
git push origin feature_x

5. Go to the github repository and submit the pull request, using our PULL_TEMPLATE.md

6. If there are no conflicts, wait for the pull request to be accepted or rejected.

7. If there are conflicts, you must either:

   • Resolve conflicts at the Pull Request one at a time
   • If conflicts are too many, in the local repository
     • switch to master
       git checkout master
     • update the master repository
       git pull
     • then merge with the feature branch
       git merge feature_x
     • If you need more information, see the Github easy guide update & merge section

8. If your pull request was accepted, you can safely delete the branch within Github after merge or locally doing the following:

   • Make sure you are on the master
     git checkout master
   • Safely delete the branch
     git branch -d feature_x

9. When you have a new feature to develop, please create a new branch and work from there.

Github easy guide: http://rogerdudler.github.io/git-guide/
Git feature workflow: https://gist.github.com/blackfalcon/8428401