arsenetar
/
dupeguru
mirror of https://github.com/arsenetar/dupeguru.git
1
0
Fork 0
Code Releases Wiki Activity

Document branching in the repo

This commit is contained in:
Virgil Dupras 2015-07-20 13:02:14 -04:00
parent 6b41223a22
commit 6930e092e0
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
help/en/developer/index.rst
View File

@ -5,6 +5,20 @@ When looking at a non-trivial codebase for the first time, it's very difficult t
anything of it until you get the "Big Picture". This page is meant to, hopefully, make you get anything of it until you get the "Big Picture". This page is meant to, hopefully, make you get
dupeGuru's big picture. dupeGuru's big picture.
Branches and tags
-----------------
The git repo has one main branch, ``master``. It represents the latest "stable development commit",
that is, the latest commit that doesn't include in-progress features. This branch should always
be buildable, ``tox`` should always run without errors on it.
When a feature/bugfix has an atomicity of a single commit, it's alright to commit right into
``master``. However, if a feature/bugfix needs more than a commit, it should live in a separate
topic branch until it's ready.
Every release is tagged with the version number. For example, there's a ``2.8.2`` tag for the
v2.8.2 release.
Model/View/Controller... nope! Model/View/Controller... nope!
------------------------------ ------------------------------