Skip to content

Latest commit

 

History

History
51 lines (51 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

51 lines (51 loc) · 3.08 KB
Raw

Contributing to Devicon

First of all, thanks for taking the time to contribute! This project can only grow and live by your countless contributions. To keep this project maintable we developed some guidelines for contributions.

Submitting icon

  • Create a separated pull request for each icon (no matter how many variations)
  • Include the name of the icon in the pull request f.e. "new icon: html5 (original, plain, line)"
  • At least the plain or line version of the icon is required (since those are required for the icon font)
  • Modify devicon.json to include the icon (or variations)
  • Modify devicon-colors.css to include the colored version of the icon
  • optional: Add a image of the new icon(s) to the description of the pull request
  • optional: Reference the issues regarding the new icon

Icon formats and naming conventions

Each icon comes in different variations:

  • original
  • original-wordmark
  • plain
  • plain-wordmark
  • line
  • line-wordmark

This is not mandatory, an icon can only have one or two variations available. Just keep in mind that the minimum is 1 and the maximum 6 (for now).

The plain and line variations (with or without wordmark) are designed to be available in the final icon font. So they need to stay as simple as possible (one color and ensure that the paths are united before to export to svg). You can use a service like compressor or SVG Editor in order to optimize the svg file.

The original versions are only available in svg format, so they do not need to be as simple and they can contain numerous colors.

Some icons are really simple (like the apple one), so the original version can be used for the icon font. In this case, I'll add an alias so they can be found with the "original" or "plain" naming convention.

Organizational guidelines

  • Each icon has his own folder located in the "icons" folder
  • Each icon folder contains one .eps file and as many .svg files as versions available
  • The .eps file contains all available versions of an icon. Each version is contained in a 128px by 128px artboard
  • Each .svg file contains one version of an icon in a "0 0 128 128" viewbox
  • The naming convention for the svg file is the following: (icon name)-(original/plain/line)-(wordmark)

Requesting a icon

When you want to request a new icon please feel free to create a issue following some simple guidelines:

  • Search for other issues already requesting the icon
  • Create an issue naming it "Icon request: name-of-the-icon"; please create separated issues for each icon
  • optional: Include links where the icon can be found