Git workflow

Table of contents

• Fork Incipio
• Keep your fork up to date
• Develop
• Submit your work
• Fore more
• Sources

Introduction

You do not have the rights to directly write on the project. Hence if you wish to push some code, the best thing to do is to fork the project. Once done, you will have a copy of the the repository CDJE/Incipio to your own namespace, with write access.

On your fork, you can develop and do changes as you wish. We recommend you to do your modifications in separate branches so that you can keep the original branches up to date with the original repository.

If you are not used to this kind of workflow, do not worry, everything is detailed below!

Fork Incipio

Nothing easier than that: go to https://github.com/CDJE/Incipio and then clic on the fork button ;)

For more, check this GitHub guide: forking projects.

Keep your fork up to date

First, clone your fork!

Here it becomes a little bit trickier if you never did it. With your fork, you can do your changes as you like it will not affect the original repository. However, sometimes changes may happen on the original repository and you want to keep your fork up to date so that you can develop with the latest work. To achieve that, you have to configure the tracked repositories.

To see which repositories are tracked, use git remote -v. The current result should be something like:

origin	[email protected]:yourNameSpace/Incipio.git (fetch)
origin	[email protected]:yourNameSpace/Incipio.git (push)

Now, add the original repository to tracked repositories: git remote add upstream [email protected]:CDJE/Incipio.git. Now if you do git remote -v again you should have:

origin	[email protected]:yourNameSpace/Incipio.git (fetch)
origin	[email protected]:yourNameSpace/Incipio.git (push)
upstream	[email protected]:CDJE/Incipio.git (fetch)
upstream	[email protected]:CDJE/Incipio.git (push)

That's it! Now, if you wish to update your repository, you can do:

• git fetch upstream: get the updates from the original repository.
• git fetch origin: get the updates of your remote repository (the fork).

Source: GitHub: syncing a fork

Develop

It is highly recommended to use the development environment provided to develop. If you want more information on it, check this link.

If you wish to properly keep your fork up to date, do not touch the original branches like master!

Now let's start. It is assumed that your repository is up to date. Create your branch featureName (the branch name has really no importance, you will be the only one to use it) from the dev branch:

git checkout origin/dev     # You are now on your remote branch `dev`
git checkout -b featureName # You are now on the branch featureName

Now you can start to code. Do not forget to follow the project contributing guidelines!

Submit your work

It is assumed that you have your latest work that you wish to submit pushed on the branch featureName on your fork. Before submitting your work, first check that your work following the project standards. Then, to clean your work, do not forget to rebase it first. Why? To ensure your work integrates the latests commits of the original repository and ease the merge! Never did that? Then do the following:

Go on your branch featureName.

Update your local repository:

git fetch upstream
git fetch origin
git pull featureName

Rebase your work:

git rebase upstream/dev

Solve the conflicts, and only the conflicts, nothing else! To do so, check the conflicted files. Once this is done, do:

git add -A
git rebase --continue

And to that until the rebase is successful :)

Now repush your work. You will probably need to do a force push.

Good! Now you can do a pull request with the original repository on the dev branch (CDJE:dev) as a base and your fork branch as HEAD (yourNameSpace:featureName).

For more

• Learn Git with pcottle
• Bien utiliser git merge et git rebase
• Getting solid at git rebase and git merge
• How to undo almost anything with Git

Last be not the least, if you feel uncomfortable with Git in command lines, checkout:

• Git GUI clients
• ungit

Good coding!

Sources

• http://bocoup.com/weblog/git-workflows-for-successful-deployment/
• https://www.lullabot.com/blog/article/git-best-practices-workflow-guidelines
• http://www.codesimplicity.com/post/the-purpose-of-software/
• http://scottchacon.com/2011/08/31/github-flow.html
• http://nvie.com/posts/a-successful-git-branching-model/
• http://www.kdgregory.com/index.php?page=scm.git
• https://sandofsky.com/blog/git-workflow.html
• http://blog.endpoint.com/2014/05/git-workflows-that-work.html
• http://stackoverflow.com/questions/2428722/git-branch-strategy-for-small-dev-team
• http://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows
• https://www.atlassian.com/git/tutorials/comparing-workflows/
• http://invenio-software.org/wiki/Tools/Git/Workflow