Skip to content

Commit

Permalink
[TASK] Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
tomvlk committed Jun 18, 2017
1 parent 7196797 commit 963506a
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ PyPlanet
.. image:: https://readthedocs.org/projects/pyplanet/badge/?version=stable
:target: http://pyplanet.readthedocs.io/en/stable/?badge=stable
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/v/pyplanet.svg
:target: http://pypi.org/pypi/pyplanet
.. image:: https://img.shields.io/docker/build/pyplanet/pyplanet.svg
:target: https://hub.docker.com/r/pyplanet/

.. image:: https://img.shields.io/badge/patreon-donate-yellow.svg
:target: https://patreon.com/pyplanet
.. image:: https://img.shields.io/badge/paypal-donate-yellow.svg
:target: https://paypal.me/tomvlk

This repo contains the PyPlanet package.

Expand All @@ -17,13 +26,14 @@ http://pypla.net/
Git Structure
-------------

Master is always the latest development environment. We develop features in different branches ``feature/*`` or ``app/*``.
Master is always the latest development environment. We develop features in different branches ``feature/*`` or ``bugfix/*`` appending
with the issue key of GitHub.

Crafting releases is done at the ``release/vX.X.X`` branches. The branch is created from the master at the moment the freeze moment goes in.
Only bug fixes are accepted to be merged into the release/* branches, name these branches ``bugfix/ISSUE-ID``.
Crafting releases is done at the ``release/vX.X.0`` branches. The branch is created from the master at the moment the freeze moment goes in.
Only bug fixes are accepted to be merged into the release/* or master branches (and merged into release again), name these branches ``bugfix/ISSUE-ID``.

After releasing (from the release branch) it gets a version tag. From this point there is no way back, new bug releases will be crafted
from the release/version branch (``release/v0.1.0`` -> ``release/v0.1.2`` and is accepting merges from ``bugfix/*``).
from the release branch (``release/v0.1.0`` for example).

Visualization of our current release schedule can be found here: `Release Schedule <https://github.com/PyPlanet/PyPlanet/projects/3>`_

Expand Down

0 comments on commit 963506a

Please sign in to comment.