Page History

...

1. The first order of business will be determining if this requirement should be contributed to the latest version of the requirements, or if it is intended for a prior release.  If you simply, just need to make a change to the latest content then jump to step 3
2. If you wish to change content in a prior release, then you must checkout that branch.  For example, if the master branch is now associated with Dublin, but the change you need to make is for Casablanca, then you will need to do the following:

   1. Fetch the remote branches and checkout the appropriate release branch

      Code Block
      > git fetch > get checkout casablanca (Or whatever the appropriate release branch name is)

      
      

3. If you will be adding requirements

   (NOTE: this is only applicable when working on the vnfrqts/requirements repository), then you will need a block of requirement IDs to use.  Determine the number of requirements you intend to add and use the make_ids.py to generate the requirement IDs (don't worry you can always generate more)


   The following command will generate 5 random, unique requirement IDs for your use.  The requirement IDs you generate will not conflict with any requirement already in the document, but they are not strictly reserved.  The build process will throw an error if your requirement ID is a duplicate.

   Code Block

   language	bash
   title	Generate Requirement IDs

   <project-dir> python make_ids.py 5 R-##### R-##### R-##### R-##### R-#####

   , go to the VNFRQTS Requirement Generation Tool, click Generate ID, fill out the form with the appropriate fields, and click Convert to RST. This will generate RST under the Convert to RST button, you can copy this generated RST and use it in the RST documents.

4. Edit the RST documents in the docs folder.  Be sure to format any requirements according using the .. req:: directive as defined in the standards. Paste the generated RST from step 3.
   
   

   Code Block
   language text title Example Requirement
   .. req:: :id: R-12345 :keyword: MUST :target: VNF PACKAGE :introduced: casablanca :impacts: sdc :validation_mode: static The VNF Package **MUST** include element XYZ as part of the CSAR package in the ABC directory

   
   

5. After you have made your changes, rebuild the documentation using the tox -e docs command, and view the changes in browser to ensure they are formatted correctly.  This will also regenerate the JSON version of the requirements that are located in docs/data/needs.json.  This is the file make_ids.py uses to ensure new requirement IDs do not conflict and the JSON version is also downloadable via the Requirements List chapter of the Requirements document.
6. Once you are satisfied with your change, then it will be time to commit and submit your changes for review

...