Contributing

Thank you for your interest in contributing to OVS!

Ways to contribute

  • Propose schema improvements
  • Add or correct dataset records
  • Improve validator, CLI, converters, and docs
  • Help review and triage issues

Principles

  • Open, free, community-driven
  • Neutral and vendor-agnostic
  • Transparent data definitions
  • Stable long-term IDs

Process

  1. Open an issue describing your change
  2. Discuss design and alignment with principles
  3. Submit a PR with tests/validation
  4. Ensure deterministic ID stability is preserved

Please do not submit proprietary data.

Scope of changes

  • Submit PRs that change only the dataset JSON in data/reference/, or add release snapshots in data/YYYY/.
  • Schema changes should be proposed and discussed before implementation; breaking changes require a new MAJOR version.

CI validation

All submissions are validated by CI to ensure:

  • Conformance to the JSON Schemas in /schemas
  • Deterministic OVS ID stability
  • Formatting and structural correctness

Note: Examples on this site are illustrative.

← Back to Docs Hub