Common Guidelines for Schemas (Proposed)

This document proposes a number of guidelines for schemas managed by the Schema Board. If adopted, over time all schema will be updated to meet these guidelines.

1. Each Schema will be assigned a git repository in the REFEDS GitHub account.
2. Each Schema will maintain two documents at the top level of the repository:
   1. The Schema document, which is organized into the following sections:
      1. Introduction
      2. Narrative
      3. Technical Specification
      4. Examples
      5. References
   2. A README document, which includes
      1. A link to the most current version of the Schema document
      2. Links to product specific schema and ldif files
      3. High level version history
3. Product specific schema and ldif files will be placed in product-specific sub-directories under the schema directory. eg: REPO/schema/openldap, REPO/schema/389-ds, etc.
4. Schemas shall be versioned, with corresponding product specific files. Versions will be denoted via git tags as well as a version label in each relevant file.
5. The issue tracker for each repository shall be open to the public, and additionally members of the public may submit pull requests against each repository. However, all submissions are subject to the REFEDS Participant's Agreement and Board review.