|
|
| (7 intermediate revisions by 5 users not shown) |
| Line 1: |
Line 1: |
| − | == Coding Guidelines ==
| + | This page has migrated to [https://docs.openstack.org/blazar/latest/contributor/development.html here]. |
| − | | |
| − | [http://legacy.python.org/dev/peps/pep-0008/ PEP8] checking should pass for all Climate 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 [http://www.pylint.org pylint]:
| |
| − | | |
| − | tox -e pylint
| |
| − | | |
| − | If you'll see any pep8/pylint errors in your code, it's mandatory to fix them before sending your change on review.
| |
| − | | |
| − | == Testing Guidelines ==
| |
| − | | |
| − | Climate 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:
| |
| − | | |
| − | tox -e py27
| |
| − | tox -e py26
| |
| − | | |
| − | for Python 2.7 and Python 2.6 accordingly.
| |
| − | | |
| − | == Documentation Guidelines ==
| |
| − | | |
| − | Currently Climate docs are partially written on [https://wiki.openstack.org/wiki/Climate 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 (now these docs cannot be published on readthedocs.org, because there is already existing '''climate''' project created on it. Now Climate ATCs are voting to choose new name for Climate project and then all docs will be moved to new readthedocs project).
| |
| − | | |
| − | 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'''''.
| |
Latest revision as of 07:21, 7 February 2018
This page has migrated to here.
