matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation: Expand the Source control section

Browse Source 
Add new subsection explaining commit messages structure to be
used in the project.

Updates and expands explanations regarding the Git branch
structure used in the project.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2018-10-31 17:24:43 -04:00
parent e109068b29
commit 8b41a9bfc9
1 changed files with 61 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/chapters/development.rst
View File

@@ -226,17 +226,37 @@ Git branch structure
Mayan EDMS follows a simplified model layout based on Vincent Driessen's Mayan EDMS follows a simplified model layout based on Vincent Driessen's
`Successful Git Branching Model`_ blog post. `Successful Git Branching Model`_ blog post.
``develop`` ``development``
The "next release" branch, likely unstable. The "next release" branch, likely unstable, don't use in production.
``master`` ``master``
Current production release (|version|). Current production release (|version|). Points to the latest version of
the latest series. Production quality code.
``feature/`` ``feature/``
Unfinished/unmerged feature. Unfinished/unmerged feature. Likely unstable, don't use in production.
``series/``
Released versions.
Special branches:
Each release is tagged separately. ``releases/all``
Used by the continuous delivery system to trigger the build and release
a new Docker image, Documentation and Python package.
``releases/docker``
Used by the continuous delivery system to trigger the build and release
of a new Docker image to Docker Hub.
``releases/documentation``
Used by the continuous delivery system to trigger the build and release
of new documentation.
``releases/python``
Used by the continuous delivery system to trigger the build and release
of a new Python package to PyPI.
``releases/python``
Used by the continuous delivery system to trigger the build and release
of a new Python package to PyPI.
``nightly``
Used by the continuous delivery system to trigger the build and release
of a new Docker image based on development code to the GitLab image
repository.
Each release is tagged separately using annotaded Git tags.
When submitting patches, please place your code in its own ``feature/`` branch When submitting patches, please place your code in its own ``feature/`` branch
prior to opening a Merge Request on GitLab_. prior to opening a Merge Request on GitLab_.
@@ -245,6 +265,40 @@ prior to opening a Merge Request on GitLab_.
.. _`Successful Git Branching Model`: http://nvie.com/posts/a-successful-git-branching-model/ .. _`Successful Git Branching Model`: http://nvie.com/posts/a-successful-git-branching-model/
Commit messages
---------------
#. Use English as the language for the commit messages.
#. Provide a subject line composed of a tag and a short explanation::
Indexing: Add document base property reindex
#. Keep the subject line to 50 or less characters.
#. Capitalize the subject line.
#. Don't end the subject line with a period, leave like a phrase in English.
#. Use active voice in the. Say what the commit will do when applied not what
you did::
Add new properties to the model.
Vs.
::
Added new properties to the model.
#. Limit the body of the commit to 72 characters.
#. When a commit fixes or improves an issue add the issue number in the commit
message. Either in the subject or in the body.
#. Sign commit messages.
#. Use explicit language even for minor commits. Don't do::
Fix typo
Use::
Document: Fix typo in label description
Steps to deploy a development version Steps to deploy a development version
===================================== =====================================