diff options
| author | Mauricio Lima <mauriciolimab@gmail.com> | 2016-04-13 12:55:55 -0400 |
|---|---|---|
| committer | Mauricio Lima <mauriciolimab@gmail.com> | 2016-05-04 08:10:33 -0400 |
| commit | 6dfc1ef650ea6ed369f9c1939c78af47308b42e2 (patch) | |
| tree | d2cd9ea86492876fc825ea835ee7ab2ee5d513e2 /doc/CONTRIBUTING.rst | |
| parent | cdcee4bdaf53d4ed33cd66975cdd1e8772d60b78 (diff) | |
| download | kolla-6dfc1ef650ea6ed369f9c1939c78af47308b42e2.tar.gz kolla-6dfc1ef650ea6ed369f9c1939c78af47308b42e2.zip | |
Add a CONTRIBUTING.rst for Kolla
Change-Id: I9910b4fba5ef11c26e687af3273e4fccaf5f235f
Closes-Bug: #1570017
Diffstat (limited to 'doc/CONTRIBUTING.rst')
| -rw-r--r-- | doc/CONTRIBUTING.rst | 35 |
1 files changed, 35 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 |