Skip to content

Contributing

We want contributions from the whole industry: affiliates, AM/BD teams, product owners, analysts, and researchers.

Ways to contribute

  • Add a new record (entity / taxonomy term / relation)
  • Update contacts, websites, descriptions, or status
  • Add sources to improve trust
  • Report issues or propose new taxonomies/fields

Adding a new entity

  1. Pick entity_type (or propose a new one)
  2. Copy templates/entity.yml
  3. Save as data/entities/<entity_type>/<id>.yml
  4. Ensure id matches the filename and entity_type matches the directory name

Adding a new taxonomy term

  1. Pick taxonomy (or propose a new one)
  2. Copy templates/taxonomy_term.yml
  3. Save as data/taxonomies/<taxonomy>/<term_id>.yml

Adding a new relation

  1. Copy templates/relation.yml
  2. Save as data/relations/<id>.yml
  3. Use predicate terms from data/taxonomies/relation_predicate/
  1. Fork the repo
  2. Create a branch
  3. Add / edit YAML files under data/
  4. Run validation locally (optional but recommended)
  5. Open a Pull Request

Local validation

python3 -m tools.validate

Local build (API + browsable pages)

python3 -m tools.build --generate-docs

Data principles

  • No paid placements
  • Every non-trivial fact should have a source
  • Prefer taxonomies over free-form strings
  • Keep IDs stable (rename carefully)