mirror of
https://github.com/arsenetar/dupeguru.git
synced 2025-03-09 21:24:36 +00:00
Document branching in the repo
This commit is contained in:
parent
6b41223a22
commit
6930e092e0
@ -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
|
||||
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!
|
||||
------------------------------
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user