FVDE/ennstatus Changeset - da91981973fc · Chaos Computer Club Lëtzebuerg Projects

Changeset - da91981973fc

Parent rev.

Child rev.

[Not reviewed]

feature-readme

0 1 0

Dennis Fink - 9 years ago 2015-10-27 22:56:38
dennis.fink@c3l.lu

Added an about paragraph to the readme

1 file changed with 12 insertions and 0 deletions:

README.rst

0 comments (0 inline, 0 general)

README.rst

➞

Show inline comments

 =========
 Ënnstatus
 =========
 Ënnstatus is a web application written in Python_ Flask_, to provide viewers
 with vital information about the organisation and Tor_ servers of `Frënn vun
 der Ënn A.S.B.L.`_
 .. _Python: http://python.org
 .. _Flask: http://flask.pooco.org
 .. _Tor: https://torproject.lu
 .. _Frënn vun der Ënn A.S.B.L.: https://enn.lu
 TOC
 ===
 - Contribute_
   - Versioning_
   - Repository_
     - `Branch Structure`_
     - `Feature Requests`_
     - `Pull Requests`_
 _ Authors_
   - `Development Lead`_
   - `Contributors`_
 .. _Contribute:
 Contibute
 =========
 Versioning
 ----------
 This project uses the `Semantic Versioning`_ system.
 .. _Repository:
 Repository
 ----------
 .. _Branch Structure:
 Branch Structure
 ++++++++++++++++
 The branch structure of this project is very similiar to the `git-flow`_
 branching model, but with some modifications (we don't have release branches).
 Description of the branches:
 - **default**: This is the stable branch.
 - **stable**: This is the main development branch.
 - **hotfix-***: These branches branch off from the default branch and are used to
   fix bugs which are in the stable version. They will be merged back into
   *default* and *dev*. After the bug is fixed, the *PATCH* number must be
   increased!
 - **feature-***: In these branches, we will implement new features. These will
   branch off from the *dev* branch and merged back into the *dev* branch, if
   the feature is completed!

0 comments (0 inline, 0 general)