Commit 1852c8d1 authored by Daniele Venzano's avatar Daniele Venzano

Add a contributing section in the documentation

parent 5725ae2e
.. _contributing:
Contributing to Zoe
===================
Zoe is an open source and project: we welcome any kind of contribution to the code base, the documentation, on the general architecture. Bug reports and features requests are also accepted and treasured.
To better work together we have established some rules on how to contribute.
Bug reports and feature requests
--------------------------------
Bug reports and feature requests are handled through the GitHub issue system.
For Zoe itself, issues should be reported here: `https://github.com/DistributedSystemsGroup/zoe/issues <https://github.com/DistributedSystemsGroup/zoe/issues>`_
For the sample Zoe applications we provide, reports should be sent here: `https://github.com/DistributedSystemsGroup/zoe-applications/issues <https://github.com/DistributedSystemsGroup/zoe-applications/issues>`_
The issue system should be used for only for bug reports or feature requests. If you have more general questions, you need help setting up Zoe or running some application, please use the mailing list.
The mailing list
----------------
The first step is to subscribe to the mailing list: `http://www.freelists.org/list/zoe <http://www.freelists.org/list/zoe>`_
Use the mailing list to stay up-to-date with what other developers are working on, to discuss and propose your ideas. We prefer small and incremental contributions, so it is important to keep in touch with the rest of the community to receive feedback. This way your contribution will be much more easily accepted.
Code and documentation contributions
------------------------------------
To contribute code and/or documentation you should follow this workflow:
1. announce your idea on the mailing list, to prevent duplicated work
2. fork the Zoe repository via GitHub (if you don't already have a fork)
3. create a branch that will hold your changes
4. ... develop and debug ...
5. generate a pull request via GitHub
Zoe maintainers will review pull requests, give constructive feedback and eventually merge them.
......@@ -47,6 +47,7 @@ Contents
vision
motivations
roadmap
contributing
Zoe applications
----------------
......
.. _contributing:
.. _zapps_contributing:
Contributing ZApps
------------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment