openstack/kolla-ansible
Code Issues Proposed changes

Merge "Add a CONTRIBUTING.rst for Kolla"

Browse Source
This commit is contained in:
Jenkins 2016-05-05 09:49:59 +00:00 committed by Gerrit Code Review
commit 0691b0f14e
2 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,35 @@
=================
How To Contribute
=================
Basics
~~~~~~
* Our source code is hosted on `OpenStack GitHub`_, but pull requests submitted
through GitHub will be ignored. Bugs should be filed on launchpad_,
not GitHub.
* Please follow OpenStack `Gerrit Workflow`_ to to contribute to Kolla.
* Note the branch you're proposing changes to. ``master`` is the current focus
of development. Kolla project has a strict policy of only allowing backports
in ``stable/branch``, unless when not applicable. A bug in a ``stable/branch``
will first have to be fixed in ``master``.
* Please file a launchpad_ blueprint for any significant code change and a bug
for any significant bug fix or add a TrivialFix tag for simple changes.
See how to reference a bug or a blueprint in the commit message here_
* TrivialFix tags or bugs are not required for documentation changes.
.. _OpenStack GitHub: https://github.com/openstack/kolla
.. _Gerrit Workflow: http://docs.openstack.org/infra/manual/developers.html#development-workflow
.. _launchpad: https://bugs.launchpad.net/kolla
.. _here: https://wiki.openstack.org/wiki/GitCommitMessages
Development Environment
~~~~~~~~~~~~~~~~~~~~~~~
* Please follow our `quickstart`_ to deploy your environment and test your changes
.. _quickstart: http://docs.openstack.org/developer/kolla/quickstart.html

1
doc/index.rst
View File

@ -32,6 +32,7 @@ Kolla Overview
.. toctree::
:maxdepth: 1
CONTRIBUTING
deployment-philosophy
quickstart
heat-dev-env