From 39e1057589f0c1747325659328d801232c2335cd Mon Sep 17 00:00:00 2001 From: Sergey Lukjanov Date: Wed, 24 Sep 2014 17:43:08 -0700 Subject: [PATCH] Add how to participate doc We have a separated doc for client, so, we need to replicate how to participate doc too. Change-Id: I73d9e5cb83a672915cf0110771ae6f79f5f47436 --- doc/source/how_to_participate.rst | 69 +++++++++++++++++++++++++++++++ doc/source/index.rst | 1 + 2 files changed, 70 insertions(+) create mode 100644 doc/source/how_to_participate.rst diff --git a/doc/source/how_to_participate.rst b/doc/source/how_to_participate.rst new file mode 100644 index 00000000..43b6a107 --- /dev/null +++ b/doc/source/how_to_participate.rst @@ -0,0 +1,69 @@ +How to Participate +================== + +Getting started +--------------- + +* Create account on `Github `_ + (if you don't have one) + + * Make sure that your local git is properly configured by executing + ``git config --list``. If not, configure ``user.name``, ``user.email`` + +* Create account on `Launchpad `_ + (if you don't have one) + +* Subscribe to `OpenStack general mail-list `_ + +* Subscribe to `OpenStack development mail-list `_ + +* Create `OpenStack profile `_ + +* Login to `OpenStack Gerrit `_ with your + Launchpad id + + * Sign `OpenStack Individual Contributor License Agreement `_ + * Make sure that your email is listed in `identities `_ + +* Subscribe to code-reviews. Go to your settings on http://review.openstack.org + + * Go to ``watched projects`` + * Add ``openstack/sahara``, ``openstack/sahara-dashboard``, + ``openstack/sahara-extra``, ``openstack/python-saharaclient``, + ``openstack/sahara-image-elements``, ``openstack/horizon`` + + +How to stay in touch with the community? +---------------------------------------- + +* If you have something to discuss use + `OpenStack development mail-list `_. + Prefix mail subject with ``[Sahara]`` + +* Join ``#openstack-sahara`` IRC channel on `freenode `_ + +* Join public weekly meetings on *Thursdays at 18:00 UTC* on + ``#openstack-meeting-alt`` IRC channel +* Join public weekly meetings on *Thursdays at 14:00 UTC* on + ``#openstack-meeting-3`` IRC channel + + +How to send your first patch on review? +--------------------------------------- + +* Checkout Sahara code from `Github `_ + +* Carefully read https://wiki.openstack.org/wiki/Gerrit_Workflow + + * Pay special attention to https://wiki.openstack.org/wiki/Gerrit_Workflow#Committing_Changes + +* Apply and commit your changes + +* Make sure that your code passes ``PEP8`` checks and unit-tests. + See :doc:`development.guidelines` + +* Send your patch on review + +* Monitor status of your patch review on https://review.openstack.org/#/ + + diff --git a/doc/source/index.rst b/doc/source/index.rst index 807687ed..ddbaf07f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -21,6 +21,7 @@ Contents: :maxdepth: 2 api + how_to_participate Contributing ============