CONTRIBUTING.md

Contributing Guide

Table of Contents

• Contributing Guide
  • Table of Contents
• Requirements
• Introduction
• Schema
• Expressions
• Testing
• Packages
  • The anatomy of a package
  • Package specification
    • name
    • description
    • homepage
    • licenses
    • languages
    • categories
    • deprecation
    • source
    • bin
    • share
    • opt
• Language Servers
  • The anatomy of a language server
  • Language Server specification

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14][bcp14], [RFC2119][rfc2119], and [RFC8174][rfc8174] when, and only when, they appear in all capitals, as shown here.

Requirements

At least one of the following conditions MUST be fulfilled for new tools to be added to the registry.

1. At least 100 stars on GitHub.
2. The tool is officially recommended by a reputable consortium, foundation, or company.

Even if one, or all, of the previous conditions are fulfilled, new package additions may be rejected for other reasons.

Introduction

• Make sure to follow the naming guidelines.
• Refer to the common fields example for a good starting point for a new package.
• Refer to the different examples and/or existing package definitions for further guidance.
• Testing a package MUST be done locally prior to creating a PR. See testing for more information.