utilities/HACKING.rst
Al Bailey d7051e8c55 Adding zuul jobs for new repo
This job adds a single linters tox target.

The linters target is an aggregation of linters for
this repo including:
 - flake8
 - bashate

Other linters such as yamllint can be added to this
repo by later commits.

Certain bashate and flake8 codes are suppressed. They
can be enabled by later commits.

This commit also adds basic contributing and hacking docs.

Change-Id: I3d12e16b09d94a5eb1f6ea5e7e77f78bc082af84
Story: 2006166
Task: 36536
Signed-off-by: Al Bailey <Al.Bailey@windriver.com>
2019-09-09 13:43:49 -05:00

18 lines
492 B
ReStructuredText

StarlingX Utilities Style Commandments
======================================
- Step 1: Read the OpenStack style commandments
https://docs.openstack.org/hacking/latest/
- Step 2: Read on
Utilities Specific Commandments
-------------------------------
None so far
Running tests
-------------
The approach to running tests is to simply run the command ``tox``. This will
create virtual environments, populate them with dependencies and run all of
the tests that OpenStack CI systems run.