For all the code in Murano we have a rule - it should pass PEP 8.
To check your code against PEP 8 run:
tox -e pep8
Murano team uses the murano-specs repository for its blueprint and specification (specs) review process. See Launchpad to propose or see the status of a current blueprint.
Murano has a suite of tests that are run on all submitted code, and it is recommended that developers execute the tests themselves to catch regressions early. Developers are also expected to keep the test suite up-to-date with any submitted code changes.
Unit tests are located at murano/tests
.
Murano’s suite of unit tests can be executed in an isolated environment with Tox. To execute the unit tests run the following from the root of Murano repo on Python 2.7:
tox -e py27
Murano dev-docs are written using Sphinx / RST and located in the main repo
in doc
directory.
The documentation in docstrings should follow the PEP 257 conventions (as mentioned in the PEP 8 guidelines).
More specifically:
Run the following command to build docs locally.
tox -e docs
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.