Difference between revisions of "Blazar/Development Guidelines"
m (Sergey Lukjanov moved page Climate/Development Guidelines to Blazar/Development Guidelines: Climate project has been renamed to the Blazar project due to the possible trademark issues.) |
|||
| Line 1: | Line 1: | ||
== Coding Guidelines == | == Coding Guidelines == | ||
| − | [http://legacy.python.org/dev/peps/pep-0008/ PEP8] checking should pass for all | + | [http://legacy.python.org/dev/peps/pep-0008/ PEP8] checking should pass for all Blazar code. You may check it using the following command: |
tox -e pep8 | tox -e pep8 | ||
| Line 13: | Line 13: | ||
== Testing Guidelines == | == Testing Guidelines == | ||
| − | + | Blazar repositories have unit tests that are run on all submitted code, and it is recommended for developers to execute them themselves to catch regressions early. Developers are also expected to keep the test suite up-to-date with any submitted code changes. | |
Unit tests might be ran in [https://testrun.org/tox/latest/ TOX] environment via commands: | Unit tests might be ran in [https://testrun.org/tox/latest/ TOX] environment via commands: | ||
| Line 24: | Line 24: | ||
== Documentation Guidelines == | == Documentation Guidelines == | ||
| − | Currently | + | Currently Blazar docs are partially written on [https://wiki.openstack.org/wiki/Blazar OpenStack wiki] pages, and partially using Sphinx / RST located in the main repo in '''''doc''''' directory. In future all of them will be moved to Sphinx / RST. |
To build Sphinx / RST docs locally run the following command: | To build Sphinx / RST docs locally run the following command: | ||
Revision as of 20:54, 5 June 2014
Coding Guidelines
PEP8 checking should pass for all Blazar code. You may check it using the following command:
tox -e pep8
Also you should keep your code clear using more code style checkings via pylint:
tox -e pylint
If you see any pep8/pylint errors in your code, it's mandatory to fix them before sending your change on review.
Testing Guidelines
Blazar repositories have unit tests that are run on all submitted code, and it is recommended for developers to execute them themselves to catch regressions early. Developers are also expected to keep the test suite up-to-date with any submitted code changes.
Unit tests might be ran in TOX environment via commands:
tox -e py27 tox -e py26
for Python 2.7 and Python 2.6 accordingly.
Documentation Guidelines
Currently Blazar docs are partially written on OpenStack wiki pages, and partially using Sphinx / RST located in the main repo in doc directory. In future all of them will be moved to Sphinx / RST.
To build Sphinx / RST docs locally run the following command:
tox -e docs
After it you can access generated docs in doc/build/ directory, for example, main page - doc/build/html/index.html.
