From 6dfc1ef650ea6ed369f9c1939c78af47308b42e2 Mon Sep 17 00:00:00 2001
From: Mauricio Lima <mauriciolimab@gmail.com>
Date: Wed, 13 Apr 2016 12:55:55 -0400
Subject: [PATCH] Add a CONTRIBUTING.rst for Kolla
Change-Id: I9910b4fba5ef11c26e687af3273e4fccaf5f235f
Closes-Bug: #1570017
---
doc/CONTRIBUTING.rst | 35 +++++++++++++++++++++++++++++++++++
doc/index.rst | 1 +
2 files changed, 36 insertions(+)
create mode 100644 doc/CONTRIBUTING.rst
diff --git a/doc/CONTRIBUTING.rst b/doc/CONTRIBUTING.rst
new file mode 100644
index 0000000000..08866bf321
--- /dev/null
+++ b/doc/CONTRIBUTING.rst
@@ -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
diff --git a/doc/index.rst b/doc/index.rst
index aeb1a13364..c25bc82122 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -32,6 +32,7 @@ Kolla Overview
.. toctree::
:maxdepth: 1
+ CONTRIBUTING
deployment-philosophy
quickstart
heat-dev-env