Adding a contributing file

Describes our standards for contributing to the Syntribos project.

Change-Id: Ie995e6ec98c4e48897156db89468a0648d9e07a0
Implements: blueprint add-contributing-doc
This commit is contained in:
Charles Neill 2016-03-29 15:43:13 -05:00
parent f39f59c294
commit 80344f0d46
3 changed files with 51 additions and 0 deletions

25
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,25 @@
Syntribos Contributing Guidelines
=================================
1. Follow all the `OpenStack Style Guidelines <http://docs.openstack.org/developer/hacking/>`__
(e.g. PEP8, Py3 compatibility)
2. All new classes/functions should have appropriate docstrings in
`RST format <https://pythonhosted.org/an_example_pypi_project/sphinx.html>`__
3. All new code should have appropriate unittests (place them in the
``tests/unit`` folder)
4. No new code will be accepted if it adds a new dependency on OpenCAFE, or adds
on top of existing CAFE functionality IF it cannot stand on its own without
CAFE.
Anyone wanting to contribute to OpenStack must follow
`the OpenStack development workflow <http://docs.openstack.org/infra/manual/developers.html#development-workflow>`__
All changes should be submitted through the code review process in Gerrit
described above. All pull requests on Github will be closed/ignored.
Bugs should be filed on the `Syntribos launchpad site <https://bugs.launchpad.net/syntribos>`__,
and not on Github. All Github issues will be closed/ignored.
Breaking changes, feature requests, and other unprioritized work should first be
submitted as a blueprint `here <https://blueprints.launchpad.net/syntribos>`__
for review.

View File

@ -0,0 +1,25 @@
Contributing Guidelines
=================================
1. Follow all the `OpenStack Style Guidelines <http://docs.openstack.org/developer/hacking/>`__
(e.g. PEP8, Py3 compatibility)
2. All new classes/functions should have appropriate docstrings in
`RST format <https://pythonhosted.org/an_example_pypi_project/sphinx.html>`__
3. All new code should have appropriate unittests (place them in the
``tests/unit`` folder)
4. No new code will be accepted if it adds a new dependency on OpenCAFE, or adds
on top of existing CAFE functionality IF it cannot stand on its own without
CAFE.
Anyone wanting to contribute to OpenStack must follow
`the OpenStack development workflow <http://docs.openstack.org/infra/manual/developers.html#development-workflow>`__
All changes should be submitted through the code review process in Gerrit
described above. All pull requests on Github will be closed/ignored.
Bugs should be filed on the `Syntribos launchpad site <https://bugs.launchpad.net/syntribos>`__,
and not on Github. All Github issues will be closed/ignored.
Breaking changes, feature requests, and other unprioritized work should first be
submitted as a blueprint `here <https://blueprints.launchpad.net/syntribos>`__
for review.

View File

@ -28,6 +28,7 @@ Index
logging
test.anatomy
unittests
contributing
Project information