airship
/
airship-in-a-bottle
Code Issues Proposed changes

Update UCP code standards to include make target for tests 

Change-Id: Idc7294e0caf28eb7d58074296fce773ad9817971
This commit is contained in:
Bryan Strassner 2018-05-03 11:55:45 -05:00
parent 833539a250
commit f81a666d5e
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/source/code-conventions.rst
View File

@ -74,13 +74,14 @@ should implement each of the following makefile targets:
least) test of the image's functionality. least) test of the image's functionality.
- ``run_images`` performs the inidividual run_{component_name} targets for - ``run_images`` performs the inidividual run_{component_name} targets for
projects that produce more than one image. projects that produce more than one image.
- ``tests`` to invoke linting tests (e.g. PEP-8) and unit tests for the
components in the project
Other makefile targets may exist. A ``test`` endpoint is encouraged. For For projects that are Python based, the makefile targets typically reference
projects that are Python based, the makefile targets typically reference tox tox commands, and those projects will include a tox.ini defining the tox
commands, and those projects will include a tox.ini defining the tox targets. targets. Note that tox.ini files will reside inside the source directories for
Note that tox.ini files will reside inside the source directories for modules modules within the project, but a top-level tox.ini may exist at the root of
within the project, but a top-level tox.ini may exist at the root of the the repository that includes the necessary targets to build documentation.
repository that includes the necessary targets to build documentation.
Documentation Documentation
~~~~~~~~~~~~~ ~~~~~~~~~~~~~