aboutsummaryrefslogtreecommitdiff
path: root/doc/CONTRIBUTING.rst
blob: e6ec7a7fe71111a0623b9660b6c40f8d68517a0b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
.. _CONTRIBUTING:

=================
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