diff options
| author | Jenkins <jenkins@review.openstack.org> | 2016-05-05 09:49:59 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2016-05-05 09:49:59 +0000 |
| commit | 0691b0f14e71336d2990b7a10732daf5de6345a7 (patch) | |
| tree | 95fa23337478581ab8723f42ff66140e921b3a69 /doc | |
| parent | 696f0b9a06e415d8ef320bd8279c4911edbaca7f (diff) | |
| parent | 6dfc1ef650ea6ed369f9c1939c78af47308b42e2 (diff) | |
| download | kolla-0691b0f14e71336d2990b7a10732daf5de6345a7.tar.gz kolla-0691b0f14e71336d2990b7a10732daf5de6345a7.zip | |
Merge "Add a CONTRIBUTING.rst for Kolla"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CONTRIBUTING.rst | 35 | ||||
| -rw-r--r-- | doc/index.rst | 1 |
2 files changed, 36 insertions, 0 deletions
diff --git a/doc/CONTRIBUTING.rst b/doc/CONTRIBUTING.rst new file mode 100644 index 000000000..08866bf32 --- /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 aeb1a1336..c25bc8212 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 |