aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/Developer/git_repo.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/Developer/git_repo.rst')
-rw-r--r--docs/en/Developer/git_repo.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/en/Developer/git_repo.rst b/docs/en/Developer/git_repo.rst
new file mode 100644
index 00000000..4fa5c608
--- /dev/null
+++ b/docs/en/Developer/git_repo.rst
@@ -0,0 +1,29 @@
1Git repository
2==============
3
4If you wish to contribute to the project by suggesting new features or
5by fixing some bugs, please follow the recommendations below regarding
6the git repository available at https://github.com/wallabag/wallabag.
7
8Current state
9-------------
10
11To manage the different versions of wallabag, we use Git.
12
13There are multiple branches for the source code of wallabag web app:
14
15- ``master`` branch : this is the stable branch, downloaded by those
16 who wish to install wallabag for their own use.
17- ``dev`` branch : before being added on ``master`` branch, all bug
18 fixes and new features must go on that branch. This branch is not
19 recommended for production use.
20- ``v2`` branch : this is the branch for a revamp of wallabag.
21 A whole chapter is to be focused on it.
22
23Workflow
24--------
25
26All the rules for contributing to the git repository are in the
27`CONTRIBUTING.md file of
28wallabag <https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md>`__.
29Please read carefully this file before you make any change.