Skip to content

Commit dad9f61

Browse files
committed
Added a section on svg standards to CONTRIBUTING.md
1 parent bf0d48c commit dad9f61

1 file changed

Lines changed: 20 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@ First of all, thanks for taking the time to contribute! This project can only gr
66
<h2>Table of Content</h2>
77
<ul>
88
<li><a href="#overview">Overview on Submitting Icon</a></li>
9-
<li><a href="#iconFormat">Icon Formats and Naming Conventions</a></li>
9+
<li><a href="#versionNaming">Naming Conventions</a></li>
10+
<li><a href="#svgStandards">SVG Standards</a></li>
1011
<li><a href="#orgGuidelines">Organizational Guidelines</a></li>
1112
<li><a href="#updateDevicon">Updating the <code>devicon.json</code></a></li>
12-
<li><a href="#examples">Example</a></li>
13+
<li><a href="#example">Example</a></li>
1314
<li><a href="#requestingIcon">Requesting An Icon</a></li>
1415
<li><a href="#buildScript">Regarding the Build Script</a></li>
1516
</ul>
@@ -31,7 +32,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
3132
</ol>
3233

3334
<hr>
34-
<h2 id='iconFormat'>Icon Formats and Naming Conventions</h2>
35+
<h2 id='versionNaming'>Versions and Naming Conventions</h2>
3536
<p>Each icon can come in different versions. So far, we have:</p>
3637
<ul>
3738
<li><b>original</b>: the original logo. Can contains multiple colors. <a href="https://github.com/devicons/devicon/blob/master/icons/amazonwebservices/amazonwebservices-original.svg"> Example </a> </li>
@@ -42,18 +43,29 @@ First of all, thanks for taking the time to contribute! This project can only gr
4243
<li><b>line-wordmark</b>: a one-color, line version of the original logo but with wordmark.<a href="https://github.com/devicons/devicon/blob/master/icons/apache/apache-line-wordmark.svg"> Example </a></li>
4344
</ul>
4445
<p>
45-
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.
46+
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.
4647
</p>
4748
<p>
48-
The <b>plain</b> and <b>line</b> 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 <a href="https://compressor.io/">compressor</a> or <a href="https://petercollingridge.appspot.com/svg-editor">SVG Editor</a> in order to optimize the svg file.
49+
The <b>plain</b> and <b>line</b> versions (with or without wordmark) are designed to be available in the final icon font.
4950
</p>
5051
<p>
51-
The original versions are only available in svg format, so they do not need to be as simple and can contain numerous colors.
52+
The <b>original</b> version are only available in svg format, so they do not need to be as simple and can contain numerous colors.
5253
</p>
5354
<p>
5455
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 <code>devicon.json</code> so they can be found with either the "original" or "plain" naming convention.
5556
</p>
5657

58+
<hr>
59+
<h2 id='svgStandards'>SVG Standards</h2>
60+
<p>Before you submit your logos/svgs, please ensure that they meet the following standard:</p>
61+
<ul>
62+
<li>The background must be transparent.</li>
63+
<li>The <b>plain</b> and <b>line</b> versions (with or without wordmark) need to stay as simple as possible. They must have only one color and the paths are united before exporting to svg.
64+
</li>
65+
<li>Optimize/compress your SVGs. You can use a service like <a href="https://compressor.io/">compressor</a> or <a href="https://petercollingridge.appspot.com/svg-editor">SVG Editor</a>.</li>
66+
<li>
67+
</ul>
68+
5769
<hr>
5870
<h2 id='orgGuidelines'>Organizational Guidelines</h2>
5971
<ul>
@@ -65,7 +77,7 @@ Some icons are really simple (like the Apple one), so the original version can b
6577
</ul>
6678

6779
<hr>
68-
<h2 id='updateDevicon'> Update the <code>devicon.json</code> </h2>
80+
<h2 id='updateDevicon'> Updating the <code>devicon.json</code> </h2>
6981
<p>
7082
Before you open a PR into Devicon, you'd have to update the <code>devicon.json</code>. This is essential for our build script to work and to document your work.
7183
</p>
@@ -110,7 +122,7 @@ Some icons are really simple (like the Apple one), so the original version can b
110122
</ol>
111123

112124
<hr>
113-
<h2>Example </h2>
125+
<h2 id='example'>Example </h2>
114126
<p>
115127
As an example, let's assume you have created the svgs for Amazon Web Services and Redhat logos.
116128
</p>

0 commit comments

Comments
 (0)