diff options
| author |   Lovett, Trevor <trevor.lovett@att.com> | 2019-09-04 12:14:04 -0500 |
|---|---|---|
| committer |   Lovett, Trevor (tl2972) <tl2972@att.com> | 2019-09-04 12:46:22 -0500 |
| commit | 3326ce230c992382896905d9b7c642faa602319c (patch) | |
| tree | 37f2121b8f36a2fc0bd7c89b5b98d68779b1c79b /docs/contributing.rst | |
| parent | 7766554b3057c8955ec8c0c15e4d9c62a83eb126 (diff) | |
[VVP] Adding documenation for preload generation
Issue-ID: VVP-279
Change-Id: Ibc30244603ddb2588348fecd51721ab11e955618
Signed-off-by: Lovett, Trevor <trevor.lovett@att.com>
Signed-off-by: Lovett, Trevor (tl2972) <tl2972@att.com>
Diffstat (limited to 'docs/contributing.rst')
| -rw-r--r-- | docs/contributing.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index 8b561af..2a3af02 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -6,7 +6,7 @@ How to Contribute ################# Overview -~~~~~~~~ +-------- This section will provide details on how to contribute changes to the project covering both the mechanics of how to contribute new code as well as @@ -14,7 +14,7 @@ how to adhere to the code quality and coding practices of the project. Prerequisites -~~~~~~~~~~~~~ +------------- As this project is part of the overall ONAP project, there are some common guidelines and activities you will need to adhere to: @@ -41,7 +41,7 @@ Other useful links: for scheduling details Objective -~~~~~~~~~ +--------- The primary focus of VVP is ensuring that a VNF that is described using Openstack Heat complies with the ONAP Heat requirements specified in the `VNF Requirements (VNFRQTS) <https://onap.readthedocs.io/en/latest/submodules/vnfrqts/requirements.git/docs/index.html>`__ @@ -63,7 +63,7 @@ requirement, then please consider making a contribution to that project first. Writing Tests -############# +------------- Coding Conventions ~~~~~~~~~~~~~~~~~~ @@ -305,7 +305,7 @@ The tests should be compatible with ``pytest``, but these tests do not use the fixtures mechanism. Submitting Your Changes For Review -################################## +---------------------------------- Once you have completed your changes and tested they work as expected, then the next step is to validate they are ready for submission. The ``checks.py`` |