Effectively using git
=====================

**NOTE**: This guide assumes that you know the basics of ``git``. If not, then you can get started `here <https://rogerdudler.github.io/git-guide/>`_.

Using a version control system such as git in a continuous integration environment can be tremendously useful. However, if the basic principles of the tool are not properly understood, it can lead to something like this:

  .. image:: https://imgs.xkcd.com/comics/git.png
     :align: center
     :target: https://imgs.xkcd.com/comics/git.png

Furthermore, if certain checks and balances are not in place, a single mistake could very dearly cost an organisation. The purpose of this guide is to demystify the pull-request workflow, lay down a set of best pratices and to provide remedies for common pitfalls. 

.. toctree::
   :maxdepth: 1

   dos-donts
   pull-request-model
   workflow-best-practices
   no-workflow
   general-best-practices
   troubleshooting
   checklist