CONTRIBUTING.md

Contributing

You can contribute to this repository to extend the schemas and add examples.

When contributing, make sure the examples are validated against the schema and that all files are formatted correctly. This repository contains tooling to help you with that.

Prerequisites

Download and install Node.js and npm. To check your Node.js and npm version:

$ node -v
$ npm -v

Then, install the dependencies:

$ npm install

Validate Definitions

To validate the examples against the schema:

$ npm run validate

Visual Studio Code

Visual Studio Code is a great editor for editing schemas. You can validate the examples automatically using the YAML plugin.

Put this in your .vscode/settings.json settings:

{
  "yaml.schemas": {
    "./schema.json": "**/*.yaml"
  }
}

Format Files

This repository enforces a JSON format to keep all the files clean and valid. To format the files in this repository:

$ npm run format