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¶
- Pick
entity_type(or propose a new one) - Copy
templates/entity.yml - Save as
data/entities/<entity_type>/<id>.yml - Ensure
idmatches the filename andentity_typematches the directory name
Adding a new taxonomy term¶
- Pick taxonomy (or propose a new one)
- Copy
templates/taxonomy_term.yml - Save as
data/taxonomies/<taxonomy>/<term_id>.yml
Adding a new relation¶
- Copy
templates/relation.yml - Save as
data/relations/<id>.yml - Use
predicateterms fromdata/taxonomies/relation_predicate/
Workflow (recommended)¶
- Fork the repo
- Create a branch
- Add / edit YAML files under
data/ - Run validation locally (optional but recommended)
- 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)