Git repository
==============

If you wish to contribute to the project by suggesting new features or
by fixing some bugs, please follow the recommendations below regarding
the git repository available at https://github.com/wallabag/wallabag.

Current state
-------------

To manage the different versions of wallabag, we use Git.

There are multiple branches for the source code of wallabag web app:

-  ``master`` branch : this is the stable branch, downloaded by those
   who wish to install wallabag for their own use.
-  ``dev`` branch : before being added on ``master`` branch, all bug
   fixes and new features must go on that branch. This branch is not
   recommended for production use.
-  ``v2`` branch : this is the branch for a revamp of wallabag.
   A whole chapter is to be focused on it.

Workflow
--------

All the rules for contributing to the git repository are in the
`CONTRIBUTING.md file of
wallabag <https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md>`__.
Please read carefully this file before you make any change.