Files
Favicons/CONTRIBUTING.md
2026-07-01 16:59:56 -05:00

1.2 KiB

Contributing

Thanks for your interest in contributing to the Favicon Fingerprint Dataset!

How to contribute

  1. Fork the repository and create your branch from main.
  2. Make your changes — whether adding new favicon hashes, correcting product identifications, improving descriptions, or fixing the tooling in scripts/.
  3. Open a pull request describing what you changed and why.

Contributing new fingerprints

When adding entries to identified.csv, please include as many fields as you can:

  • favicon_hash — MurmurHash3 of the base64-encoded favicon (signed 32-bit)
  • name and description — the identified product
  • cpe — CPE 2.3 string when known
  • md5 / sha256 / pHash — hashes of the favicon image
  • Favicon path(s) where the icon is served

If you add a favicon image, place it in images/favicons/ named {hash}.png.

Guidelines

  • Keep product identifications factual and sourced where possible.
  • Do not include any private, proprietary, or sensitive data.
  • Run the scripts in scripts/ to regenerate derived files where applicable.

Reporting issues

Use GitHub Issues for corrections, questions, or suggestions. For security concerns, see SECURITY.md.