From 7add5debcd0fa99a8da4f3228c581537cce62eac Mon Sep 17 00:00:00 2001 From: Thomas Bui Date: Fri, 11 Dec 2020 13:09:56 -0800 Subject: [PATCH] Updated rules in CONTRIBUTING.md --- CONTRIBUTING.md | 91 +++++++++++++++++++++++++------------------------ 1 file changed, 46 insertions(+), 45 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 64377230..3739a665 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,7 +51,7 @@ The plain and line versions (with or without wordmark) are designe 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. +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. Note that this only applies to font icon versions only, not the SVG versions. SVG versions don't need aliases.

@@ -94,11 +94,21 @@ Some icons are really simple (like the Apple one), so the original version can b "font": VersionString[] // list the fonts acceptable versions that you have }, "color": string, // the main color of the logo. Only track 1 color - "aliases": AliasObj[] // keeps track of the aliases + "aliases": AliasObj[] // keeps track of the aliases for the font versions ONLY } +

+ Here is what VersionString means: +

+
    +
  1. It's the version part of an `svg` file's name
    2. +
  2. If you have "html5-original", the version string would be "original"
    3. +
  3. If you have "react-line-wordmark", the version string would be "line-wordmark"
    4. +
  4. See naming conventions section for more details
    5. +
+

Here is the AliasObj interface:

@@ -110,24 +120,14 @@ Some icons are really simple (like the Apple one), so the original version can b } - -

- Here is what VersionString means: -

-
    -
  1. It's the version part of an `svg` file's name
    2. -
  2. If you have "html5-original", the version string would be "original"
    3. -
  3. If you have "react-line-wordmark", the version string would be "line-wordmark"
    4. -
  4. See Icon Formats and Naming Conventions for more details
    5. -
-
+

Example

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

-

For the Amazon Web Services svgs, you have the following versions: "original", "original-wordmark", "plain-wordmark". However, the "original" version is simple enough to be a "plain" version as well. Note that we are not using the acronym AWS.

For the Redhat svg, you have the "original", "original-wordmark", "plain", and "plain-wordmark" versions.

+

For the Amazon Web Services svgs, you have the following versions: "original", "original-wordmark", "plain-wordmark". The "original" version is simple enough to be a "plain" version as well. Note that we are not using the acronym AWS.

  1. Put the svgs for each logo that you have into its own folders in /icons @@ -139,6 +139,33 @@ As an example, let's assume you have created the svgs for Amazon Web Services an
  2. Update the devicon.json to include the icon (or variations)
      +
    • For the redhat, you would do this + 
      +          
+            {
+              "name": "redhat",
+              "tags": [
+                "server",
+                "linux"
+              ],
+              "versions": {
+                "svg": [ // here are the versions that are available in svgs
+                  "original",
+                  "original-wordmark",
+                  "plain",
+                  "plain-wordmark"
+                ],
+                "font": [ // here are the versions that will be used to create icons
+                  "plain",
+                  "plain-wordmark"
+                ]
+              },
+              "color": "#e93442", // note the '#' character
+              "aliases": [] // no aliases in this case
+            },
+          
+
      +
    • For the amazonwebservices, you would do this 
                 
@@ -156,7 +183,7 @@ As an example, let's assume you have created the svgs for Amazon Web Services an
                   "plain-wordmark"
                 ],
                 "font": [ // here are the versions that will be used to create icons
-                  "original", // original is simple enough to be used as plain
+                  "original", // "original" is simple enough to be used as the plain icon so we'll add "plain" to the aliases below
                   "plain-wordmark",
                   // note that the alias "plain" is not listed here. It must be listed in the `aliases` attribute
                 ]
@@ -164,41 +191,15 @@ As an example, let's assume you have created the svgs for Amazon Web Services an
               "color": "#F7A80D", // note the '#' character
               "aliases": [
                 {
-                    "base": "original", // here is the base version aka the one that we will upload to Icomoon
-                    "alias": "plain" // this is its alias. Our script will create a reference so we can search using "original" or "plain"
+                    "base": "original", // here is the base version that we will upload to Icomoon
+                    "alias": "plain" // this is its alias. Our script will create a reference so users can search using "original" or "plain" for this icon
+                    // note that you don't provide aliases for the svg version. If "original" is not a font version (i.e can't be made into a font), there's no need to provide it with a plain alias
                 }
               ]
             }
      • -
    • For the redhat, you would do this - 
      -          
-            {
-              "name": "redhat",
-              "tags": [
-                "server",
-                "linux"
-              ],
-              "versions": {
-                "svg": [
-                  "original",
-                  "original-wordmark",
-                  "plain",
-                  "plain-wordmark"
-                ],
-                "font": [
-                  "plain",
-                  "plain-wordmark"
-                ]
-              },
-              "color": "#e93442",
-              "aliases": [] // no aliases
-            },
-          
-
      -
    • Note: again, don't do this in the same commits. We want to have each logo in its own PR so don't create two folders in the same commit