Skip to content

README-dev.md

Latest commit

 

History

History
30 lines (18 loc) · 699 Bytes

README-dev.md

File metadata and controls

30 lines (18 loc) · 699 Bytes

Development setup and instructions

We use some code:

  • to validate the JSON schemas for correctness and format them, and
  • to validate that the test suite data files are schema-valid.

To setup an environment to contribute to the VERS spec and standard, follow these instructions:

Setup

  1. Ensure that you have a recent Python version 3 and Make installed.

  2. Configure your environment:

    make conf

Usage

To validate that the schemas and data files are correct, run:

make check

To regenerate the Python utility model code from the JSON schemas, then regenerate the VERS type documentation from the JSON VERS scheme definition files, run:

make generate
make docs