141df5400f
Implements blueprint: climate-docs Change-Id: I5e38c9609a97abd59847f7d19f79149b6f63b292
66 lines
2.5 KiB
ReStructuredText
66 lines
2.5 KiB
ReStructuredText
How to contribute
|
|
=================
|
|
|
|
Getting started
|
|
---------------
|
|
|
|
* Create `Github <https://github.com/stackforge/climate>`_ account if you don't
|
|
have one
|
|
* Make sure you have git options *user.name* and *user.email* set in git by
|
|
typing:
|
|
|
|
.. sourcecode:: console
|
|
|
|
git config --list. If not, configure them.
|
|
|
|
..
|
|
|
|
* Create `Launchpad <https://launchpad.net/climate>`_ account if you don't have
|
|
one
|
|
* Create `OpenStack profile <https://www.openstack.org/profile/>`_
|
|
* Login to `OpenStack Gerrit <https://review.openstack.org/>`_ using your
|
|
Launchpad ID
|
|
|
|
* Sign up your `OpenStack Individual Contributor License Agreement
|
|
<https://review.openstack.org/#/settings/agreements>`_
|
|
* Check that your email is listed in `Gerrit identities
|
|
<https://review.openstack.org/#/settings/web-identities>`_
|
|
|
|
* Subscribe to Climate-related projects on
|
|
`OpenStack Gerrit <https://review.openstack.org/>`_. Go to your
|
|
settings and in the watched projects add *stackforge/climate*,
|
|
*stackforge/climate-nova* and *stackforge/python-climateclient*
|
|
|
|
As all bugs/blueprints are listed in `Climate Launchpad
|
|
<https://launchpad.net/climate/>`_, you may keep track on them and choose some
|
|
to work on.
|
|
|
|
How to keep in touch with community
|
|
-----------------------------------
|
|
|
|
* If you're not subscribed to `OpenStack general mailing list
|
|
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack>`_ or to
|
|
`OpenStack development mailing list
|
|
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev>`_, do
|
|
that. Climate-related emails must be send with **[climate]** in its subject.
|
|
* All questions may be asked on our IRC channel #openstack-climate on
|
|
`freenode <http://freenode.net>`_
|
|
* We also have weekly meetings on #openstack-meeting
|
|
`freenode IRC channel <https://wiki.openstack.org/wiki/Meetings/Climate>`_
|
|
|
|
Your first commit to Climate
|
|
----------------------------
|
|
|
|
* Checkout corresponding Climate repository from `Github
|
|
<https://github.com/stackforge/climate>`_
|
|
* Take a look on how `Gerrit review process
|
|
<https://wiki.openstack.org/wiki/Gerrit_Workflow>`_ goes on in OpenStack
|
|
(read carefully `committing changes
|
|
<https://wiki.openstack.org/wiki/Gerrit_Workflow#Committing_Changes>`_ part)
|
|
* Apply and commit your changes
|
|
* Make sure all code checkings and tests have passed. See
|
|
`development guidelines <development.guidelines.html>`_ to learn more
|
|
* Send your patch to the review (you may use `git-review
|
|
<https://github.com/openstack-infra/git-review>`_ utility for that)
|
|
* Monitor status of your change on https://review.openstack.org/#/
|