diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99e8a5ca..3e2229b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,10 +6,11 @@ First of all, thanks for taking the time to contribute! This project can only gr

Table of Content

@@ -31,7 +32,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
-

Icon Formats and Naming Conventions

+

Versions and Naming Conventions

Each icon can come in different versions. So far, we have:

-It is not mandatory to have 6 versions for each icon. 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). You must also have at least one version that can be make into an icon. +It is not mandatory to have 6 versions for each icon. An icon can only have one or two versions available. Just keep in mind that the minimum is 1 and the maximum 6 (for now). You must also have at least one version that can be make into an icon.

-The plain and line versions (with or without wordmark) are designed to be available in the final icon font. This means 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 plain and line versions (with or without wordmark) are designed to be available in the final icon font.

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

Some icons are really simple (like the Apple one), so the original version can be used as the plain version and as the icon font. In this case, you'll only need to make only one of the version (either "original" or "plain"). You can then add an alias in the devicon.json so they can be found with either the "original" or "plain" naming convention.

+
+

SVG Standards

+

Before you submit your logos/svgs, please ensure that they meet the following standard:

+ +

Organizational Guidelines


-

Update the devicon.json

+

Updating the devicon.json

Before you open a PR into Devicon, you'd have to update the devicon.json. This is essential for our build script to work and to document your work.

@@ -110,7 +122,7 @@ Some icons are really simple (like the Apple one), so the original version can b
-

Example

+

Example

As an example, let's assume you have created the svgs for Amazon Web Services and Redhat logos.