Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (60 loc) · 3.82 KB

CONTRIBUTING.md

File metadata and controls

75 lines (60 loc) · 3.82 KB

Contributing

To add a new payment method icon to this repository:

  1. Fork the repository and clone it

  2. Create a branch (git checkout -b my_new_icon)

  3. Edit db/payment_icons.yml file with the name, label and group of your icon. Valid group options are as follows:

    • bank_transfers
    • convenience_stores
    • credit_cards
    • cryptocurrencies
    • other
    • wallets

  4. Add an SVG icon to the app/assets/images/payment_icons/ directory following the guidelines for new icons.

  5. Optimize your icon using SVGO (v1.x.x) - instructions below.

    npm install -g svgo@1.3.2
svgo your-icon.svg --disable={removeUnknownsAndDefaults,removeTitle,cleanupIDs,removeViewBox}

  6. Push your changes to your fork (git push origin my_new_icon)

  7. Open a pull request and one of our maintainers will review it.

The trademarks and trade names provided in this library are those of their respective owners.

Guidelines for new icons

All icon contributions must follow the guidelines below. The markup guidelines aim to make the inline SVG accessible to assistive technology; these are enforced by a suite of automatic tests. The appearance guidelines aim to provide consistency in the icons' appearance. Duplicate icons will not be accepted.

Markup

  • The root <svg> tag has the following attributes:
    • viewBox="0 0 38 24"
    • width="38" and height="24"
    • role="img"
    • aria-labelledby with the value pi- + the name of your icon
  • The root <svg> tag has a nested <title> tag with the following:
    • id attribute with the value pi- + the name of your icon, (same as the aria-labelledby)
    • Inner text containing the label of your icon
  • The <svg> must use vector graphics, i.e. path, rect, etc.
    • Nested <image> or <img> elements will only be accepted if they contain base64-encoded PNG image data. Paths to image files will not be accepted.
    • Embedded fonts or bitmaps will not be accepted.
  • All id attributes start with pi-.
  • All styles should be inline. There should be no <style>.
  • base64 encoded images are not allowed.
  • class attributes are not allowed.

Appearance

  • Logos appear on a solid color background.
    • Whenever possible, the background color should be white.
    • Whenever possible, the background color does not use a gradient fill.
    • Transparent backgrounds will not be accepted.
  • Icons have a visible border to give them a consistent shape on pages whose backgrounds match that of the icon.
    • Whenever possible, the border should be black (hex color #000) with a 7% opacity (0.07).
    • The border width must be 1px (pixel) thick.
    • The border must have a 2px radius (outside stroke).
  • Icons are clear and easy to read/understand
  • Whenever possible, provide a link to the brand icon’s brand guidelines (e.g. Google Pay)

File

  • The name of the SVG must be the same as the name entered in db/payment_icons.yml

Template

The HTML below has the required markup detailed above. Don't forget to replace {your-icon} with the appropriate text of your payment method/brand.

<svg xmlns="http://www.w3.org/2000/svg" role="img" viewBox="0 0 38 24" width="38" height="24" aria-labelledby="pi-{your-icon}">
    <title id="pi-{your-icon}">{Your icon}</title>
    <path fill="#000" opacity=".07" d="M35 0H3C1.3 0 0 1.3 0 3v18c0 1.7 1.4 3 3 3h32c1.7 0 3-1.3 3-3V3c0-1.7-1.4-3-3-3z"/>
    <path fill="#fff" d="M35 1c1.1 0 2 .9 2 2v18c0 1.1-.9 2-2 2H3c-1.1 0-2-.9-2-2V3c0-1.1.9-2 2-2h32"/>
</svg>