Contribute to the catalog

AI4AV accepts contributions through a manual maintainer queue on GitHub. A public issue never starts the scraper on its own. A maintainer triages each report and runs the private pipeline when the source is appropriate.

How to contribute

Suggest a device

A missing manufacturer, model, or family. Provide a public source URL; notes are optional.

Open issue

Report a wrong spec

A command mismatch, missing command, transport/protocol mismatch, firmware coverage gap, or provenance issue in an existing spec.

Open issue

What not to submit

Public issue bodies are untrusted input, and the catalog must stay clean of third-party material we cannot relicense. Do not paste:

  • Copied driver files or modules from another control system.
  • Private protocol manuals or NDA material.
  • Raw scraped catalogs or large command dumps from another database.
  • Credentials, API keys, or customer/site details.

Link to published manufacturer documentation where possible, or describe field verification you performed yourself.

What happens next

Both issue types land in the same maintainer queue with the needs-review label. Outcomes differ by type:

  1. Suggest a device: when the source is public and useful, the maintainer adds approved-scrape, runs the private scraper and export outside GitHub, opens a catalog PR with the new spec, and closes the issue with links to the PR and the exported spec.
  2. Report a wrong spec: the maintainer confirms the spec ID and your reproduction detail. When source evidence is missing, the maintainer applies the source-needed label. Accepted corrections land via a catalog PR against the affected spec.

Reference

Full contribution guidelines, code of conduct, and security policy live in the public repo.

CONTRIBUTING.mdCode of ConductSecurity policyRepository

Contributors with a maintainer role can manage their API key from the account page.