storyboard/CONTRIBUTING.rst
Ruslan Kamaldinov 345b1e41cf Update documentation
The goal of this patch is to setup infrastructure and organization
of docs in the project.

Changes:
* Modified README to be similar to other OS projects
* Added project description to the index page
* Added install and run guide

Note(1):
These docs will be auto-published to http://ci.openstack.org/storyboard
after each merge very soon.

Note(2):
To build docs locally run in console:
$ tox -e docs
and open doc/build/html/index.html

Change-Id: I08b57117f90f3e4614bfa5c47020e40a6c26ff65
2014-01-27 18:54:18 +04:00

47 lines
1.2 KiB
ReStructuredText

.. _contributing:
==========================
Contributing to Storyboard
==========================
If you're interested in contributing to the Storyboard project,
the following will help get you started.
Contributor License Agreement
-----------------------------
.. index::
single: license; agreement
In order to contribute to the Storyboard project, you need to have
signed OpenStack's contributor's agreement.
.. seealso::
* http://wiki.openstack.org/HowToContribute
* http://wiki.openstack.org/CLA
Project Hosting Details
-------------------------
Bug tracker
http://storyboard.openstack.org
Mailing list (prefix subjects with ``[storyboard]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-infra
Wiki
https://wiki.openstack.org/wiki/StoryBoard
Code Hosting
* https://git.openstack.org/cgit/openstack-infra/storyboard/
* https://git.openstack.org/cgit/openstack-infra/storyboard-webclient
Code Review
https://review.openstack.org/#/q/status:open+AND+(project:openstack-infra/storyboard+OR+project:openstack-infra/storyboard-webclient),n,z
Please read `GerritWorkflow`_ before sending your first patch for review.
.. _GerritWorkflow: https://wiki.openstack.org/wiki/GerritWorkflow