Changeset - 6eea4a4d3b10
[Not reviewed]
Dennis Fink - 9 years ago 2015-10-27 01:28:08
dennis.fink@c3l.lu
Added first version of the README
1 file changed with 73 insertions and 0 deletions:
0 comments (0 inline, 0 general)
README.rst
Show inline comments
 
new file 100644
 
=========
 
Ënnstatus
 
=========
 

	
 
- Contribute_
 

	
 
  - Versioning_
 
  - Repository_
 

	
 
    - `Branch Structure`_
 

	
 
_ 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!
 

	
 
.. _Semantic Versioning: http://semver.org/
 
.. _git-flow: http://nvie.com/posts/a-successful-git-branching-model/
 

	
 
.. _Authors:
 

	
 
Authors
 
=======
 

	
 
Ënnstatus is written and maintained by Dennis Fink.
 

	
 
.. _Development Lead:
 

	
 
Development Lead
 
----------------
 

	
 
- Dennis Fink <dennis.fink@c3l.lu>
 

	
 
Contributors
 
------------
 

	
 
- virii <virii@c3l.lu>
 
- kahpa <kahpa@enn.lu> 
0 comments (0 inline, 0 general)