Skip to content

raivo-otp/issuer-icons

Repository files navigation

Raivo OTP issuer icons


Vector icons (including test, build and deployment scripts) for one-time password issuers used in Raivo OTP
Raivo OTP is built by Mobime

Contributing

The example below shows how icons can be added for the services "Microsoft" and "Microsoft OneDrive".

  1. Create the directory with the primary domain name ./vectors/microsoft.com.
  2. Add a scalable Microsoft logo SVG (that meets the requirements) at ./vectors/microsoft.com/microsoft.svg.
  3. Add a scalable Microsoft OneDrive logo SVG (that meets the requirements) at ./vectors/microsoft.com/microsoft-onedrive.svg.

Requirements

If you want to contribute and add an issuer icon, make sure it adheres to the following requirements. Pull requests failing to meet these requirements will not be merged.

Must:

  • Must be a vector SVG
    • Do not convert JPG/PNG/etc to SVG
    • Do not embed JPG/PNG/etc in the SVG
  • Must be a (somewhat) square icon.
    • Prevent the use of textual icons.
  • Must be the original brand logo, not that from an icon pack.
  • Must start with the <svg> opening element
  • Must end with the </svg> closing element
  • Must be scalable (must not have static width/height attributes, use a viewBox instead).
  • Must not contain whitespace around the SVG (this JSFiddle could help to remove whitespace).
  • Must not include the doctype element.
  • The file and directory name must be lowercase.
  • Must be in the vectors/[domain name]/ directory. If the service doesn't have a domain, use [app name].app.
  • One logo per pull request.

Can:

  • Can be any color (including white and black).
    • Raivo OTP will apply effects so the icons are correctly visible in light/dark mode.

You may run the validation script before contributing a pull request to double check if your icon meets the requirements:

python scripts/validate.py

For best practice examples, check the SVG of e.g. Amazon, Adobe or Bitbucket.

Security

If you discover a security vulnerability, we would like to know about it so we can take steps to address it as quickly as possible. Please report your vulnerability via our HackerOne program. If you want to know more about how we keep Raivo OTP secure, check out the security policy.

Privacy

Raivo does not collect personally identifiable information in any way. Please refer to the privacy policy for information.

License

The source of Raivo OTP is copyrighted but available to anyone on the internet. You can use it in accordence of the license. View LICENSE.md for the full license.