Page History

...

This project welcomes and encourages contributions, feedback, and inquiries through a variety of mechanisms.  The intent of this guide is to inform a potential contributor of the various options available to them, and provide instructions on how to use those mechanisms.

Since this project is sub-an approved project of the ONAP community, most of the ways to contribute our are consistent with the standard tools used across ONAP.  Please refer to the Getting involved with the ONAP community page for general information on getting involved with ONAP.

...

• Linux Foundation ID: You will need this to access JIRA and Gerrit.  You can register for an ID here.

• Knowledge

  of

  reStructuredText

  (RST):

  All

  documentation

  at

  ONAP

  is

  authored

  in

  RST. 

  For

  the

  most

  part

  you

  can

  follow

  the

  style

  of

  other

  requirements

  and

  content

  without

  being

  an

  RST

  expert,

  but

  understanding

  basics

  may

  be

  useful. 

  The

  ONAP

  Documentation

  project

  has

  some

  useful

  guides

  and

  tutorials

  here.

• Python 2.7, 3.6+: You will not need to write any Python code, but it is required to generate the documentation from reStructuredText.  If needed, you can find installation instructions for your system here.

• Git: This is the version control tool used by ONAP. If not present on your system, then refer to Git's Getting Started - Installation Guide for more information
• Git Review: This is the command line extension to Git to enable changes to be submitted to review to Geritt.  This needs to be installed after you have installed Git and Python.

• Tox: This is a tool to run the build.  It must be installed after you install Python.  Install it using pip.

  Code Block
  > pip install tox

• VNF Requirements Standards: Familiarize yourself with the VNFRQTS Requirement and Documentation Standards

...

1. Often there will be changes you will need to make to get this working correctly.
2. Make any changes locally based on the feedback and add those those changes to be committed.

> git add --all

...

4. Finally resubmit your change via git review and your change will be updated

> getgit review

After Your Changes Are Accepted and Merged

...