You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,9 +62,9 @@ Some icons are really simple (like the Apple one), so the original version can b
62
62
<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.
63
63
</li>
64
64
<li>Optimize/compress your SVGs. You can use a service like <ahref="https://compressor.io/">compressor</a> or <ahref="https://petercollingridge.appspot.com/svg-editor">SVG Editor</a>.</li>
65
-
<li>The icon's strokes and texts must be fills. We use Icomoon to make our icon, which has its<ahref="https://icomoon.io/#docs/stroke-to-fill"> requirements</a></li>
66
-
<li>Each <code>.svg</code> file contains one version of an icon in a <code>0 0 128 128</code> viewbox</li>
67
-
<li>The naming convention for the svg file is the following: <code>(icon name)-(original|plain|line)-(wordmark)</code></li>
65
+
<li>The icon's strokes and texts must be fills. We use Icomoon to make our icon, which has its<ahref="https://icomoon.io/#docs/stroke-to-fill"> requirements.</a></li>
66
+
<li>Each <code>.svg</code> file contains one version of an icon in a <code>0 0 128 128</code> viewbox.</li>
67
+
<li>The naming convention for the svg file is the following: <code>(icon name)-(original|plain|line)(-wordmark?).</code></li>
68
68
</ul>
69
69
70
70
<hr>
@@ -87,7 +87,7 @@ Some icons are really simple (like the Apple one), so the original version can b
87
87
<pre>
88
88
<code>
89
89
{
90
-
"name": string, // the official name of the technology. Must be lower case, no space or use the dash '-' character.
90
+
"name": string, // the official name of the technology. Must be lower case, no space and don't have the dash '-' character.
91
91
"tags": string[], // list of tags relating to the technology for search purpose
92
92
"versions": {
93
93
"svg": VersionString[], // list the svgs that you have
@@ -115,6 +115,7 @@ Some icons are really simple (like the Apple one), so the original version can b
115
115
Here is what VersionString means:
116
116
</p>
117
117
<ol>
118
+
<li> It's the version part of an `svg` file's name</li>
118
119
<li> If you have "html5-original", the version string would be "original" </li>
119
120
<li> If you have "react-line-wordmark", the version string would be "line-wordmark" </li>
120
121
<li> See <ahref="#versionNaming">Icon Formats and Naming Conventions</a> for more details </li>
@@ -126,7 +127,7 @@ Some icons are really simple (like the Apple one), so the original version can b
126
127
As an example, let's assume you have created the svgs for Amazon Web Services and Redhat logos.
127
128
</p>
128
129
<p>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.</p>
129
-
<p>For the Redhat svg, you have the "original", "original-wordmark", "plain", "plain-wordmark" versions. </p>
130
+
<p>For the Redhat svg, you have the "original", "original-wordmark", "plain", and "plain-wordmark" versions. </p>
130
131
<ol>
131
132
<li>
132
133
Put the svgs for each logo that you have into its own folders in <code>/icons</code>
@@ -201,12 +202,11 @@ As an example, let's assume you have created the svgs for Amazon Web Services an
201
202
<li><b>Note</b>: 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</li>
202
203
</ul>
203
204
</li>
204
-
<li>Create a separated pull request (PR) for each icon (no matter how many variations).
205
+
<li>Create a separate pull request (PR) for each icon (no matter how many variations).
205
206
<ul>
206
207
<li>This means you would have to create two PRs</li>
207
208
<li>For Amazon Web Services, the branch name would be icons/amazonwebservices. </li>
208
209
<li>For Redhat, the branch name would be icons/redhat. </li>
0 commit comments