Add contributing documentation to Castellan

Adds documentation showing how to contribute to Castellan.

Change-Id: Id32f80329cd319f3c48ccc08456905a5824a695a
This commit is contained in:
“Fernando 2015-10-21 15:48:46 -05:00
parent 1a54b468bf
commit 6731238d2b
2 changed files with 58 additions and 14 deletions

View File

@ -1,16 +1,63 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps in this page:
============
Contributing
============
http://docs.openstack.org/infra/manual/developers.html
The best way to join the community and get involved is to talk with others
online or at a meetup and offer contributions. Here are some of the many
ways you can contribute to the Castellan project:
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
* Development and Code Reviews
* Bug reporting/Bug fixes
* Wiki and Documentation
* Blueprints/Specifications
* Testing
* Deployment scripts
http://docs.openstack.org/infra/manual/developers.html#development-workflow
Before you start contributing take a look at the `Openstack Developers Guide`_.
Pull requests submitted through GitHub will be ignored.
.. _`Openstack Developers Guide`: http://docs.openstack.org/infra/manual/developers.html
Bugs should be filed on Launchpad, not GitHub:
Freenode IRC (Chat)
-------------------
You can find Castellaneers in our publicly accessible channel on `freenode`_
``#openstack-barbican``. All conversations are logged and stored for your
convenience at `eavesdrop.openstack.org`_. For more information regarding
OpenStack IRC channels please visit the `OpenStack IRC Wiki`_.
https://bugs.launchpad.net/castellan
.. _`freenode`: https://freenode.net
.. _`OpenStack IRC Wiki`: https://wiki.openstack.org/wiki/IRC
.. _`eavesdrop.openstack.org`: http://eavesdrop.openstack.org/irclogs/
%23openstack-barbican/
Launchpad
---------
Like other OpenStack related projects, we utilize Launchpad for our bug
and release tracking.
* `Castellan Launchpad Project`_
.. _`Castellan Launchpad Project`: https://launchpad.net/castellan
.. note::
Bugs should be filed on Launchpad, not Github.
Source Repository
-----------------
Like other OpenStack related projects, the official Git repository is
available on `Castellan on GitHub`_.
.. _`Castellan on GitHub`: https://github.com/openstack/castellan
Gerrit
------
Like other OpenStack related projects, we utilize the OpenStack Gerrit
review system for all code reviews. If you're unfamiliar with using
the OpenStack Gerrit review system, please review the `Gerrit Workflow`_
wiki documentation.
.. _`Gerrit Workflow`: http://docs.openstack.org/infra/manual/developers.html#development-workflow
.. note::
Pull requests submitted through GitHub will be ignored.

View File

@ -1,4 +1 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst
.. include:: ../../CONTRIBUTING.rst