diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f0b37fa3..e3afaf9e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -22,9 +22,10 @@ First of all, thanks for taking the time to contribute! This project can only gr
Terms
Here are some terms that we will use in this repo:
- - "Icon" refers to the set of svgs/icons of a technology/tool. Ex: We might refer to the React svgs and React icons as the React Icon
- - "SVG/
.svg
" refers to the svg
versions of the Icons.
- - "icons" (lowercase) refers to the font icon versions of the Icons.
+ - "Technology" is used to describe a software, libraries, tool, etc...
+ - "Icon" refers to the svgs and icons version of a technology as a whole.
+
- "SVG/
svg
" refers to the svg
versions of the Icons.
+ - "icon" (lowercase) refers specficially to the font icon versions of the Icons.
@@ -49,9 +50,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
AngularJS becomes angularjs
or just angular
Amazon Web Services becomes amazonwebservices
Microsoft SQL Server becomes microsoftsqlserver
- Note:For JS libraries, you can also remove the "js" part if it's still recognizable.
-
Each icon/svg can come in different versions. So far, we have:
@@ -75,7 +74,6 @@ First of all, thanks for taking the time to contribute! This project can only gr
-
Some icons are really simple (ex. Apple), 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 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: this only applies to font icon versions only, not the SVG versions.
-
@@ -84,7 +82,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
Before you submit your logos/svgs, please ensure that they meet the following standard:
- The background must be transparent.
- - The svg name follows this convention:
(Icon name)-(original|plain|line)(-wordmark?).
+ - The svg name follows this convention:
(Technology name)-(original|plain|line)(-wordmark?).
- The plain and line versions (with or without wordmark) need to stay as simple as possible. They must have only one color and the paths are united. We will strip the color when turning it into icons so they can have any color.
- Optimize/compress your SVGs. You can use a service like compressor or SVG Editor.
@@ -92,7 +90,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
- Each
.svg
file contains one version of an icon in a 0 0 128 128
viewbox. You can use a service like resize-image for scaling the svg.
- The
svg
element does not need the height
and width
attributes. However, if you do use it, ensure their values are either "128"
or "128px"
. Ex: height="128"
- Each
.svg
must use the fill
attribute instead of using classes
for colors. See here for more details.
- - The naming convention for the svg file is the following:
(Icon name)-(original|plain|line)(-wordmark?).
+ - The naming convention for the svg file is the following:
(Technology name)-(original|plain|line)(-wordmark?).