diff --git a/README.rst b/README.rst new file mode 100644 --- /dev/null +++ b/README.rst @@ -0,0 +1,116 @@ +========= +Ë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: https://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! + +.. _Semantic Versioning: http://semver.org/ +.. _git-flow: http://nvie.com/posts/a-successful-git-branching-model/ + +.. _Feature Requests: + +Feature Requests +++++++++++++++++ + +We welcome feature requests. Please make sure they are within scope of Ënnstatus +goals and submit them in `Bitbucket Issues`_ with the *proposal* kind selected. +The more complete and compelling the request, the more likely it will be +implemented. Gathering community support will help as well! + +.. _Pull Requests: + +Pull Requests ++++++++++++++ + +1. Please check to make sure your plans fall within Ënnstatus scope +2. Fork Ënnstatus +3. Branch off the *dev* branch +4. Implement your changes +5. Submit a Pull Request + +Pull Requests will not be accepted without adhering to the following: + +1. Conform to existing coding styles +2. Serve a single atomic purpose (add one feature or fix one bug) +3. Introduce only changes that further the PR's singular purpose + +.. _Bitbucket Issues: https://bitbucket.org/fvde/ennstatus-relaunched/issues + +.. _Authors: + +Authors +======= + +Ënnstatus is written and maintained by Dennis Fink. + +.. _Development Lead: + +Development Lead +---------------- + +- Dennis Fink + +Contributors +------------ + +- virii +- kahpa