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
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,9 +26,8 @@ First of all, thanks for taking the time to contribute! This project can only gr
26
26
<li>Include the name of the icon in the pull request title. Follow this format: <code>new icon: {{logoName}} ({{versions}})</code> </li>
27
27
<li><i>Optional</i>: Add images of the new icon(s) to the description of the pull request. This would help speed up the review process </li>
28
28
<li><i>Optional</i>: Reference the issues regarding the new icon. </li>
29
-
<li>Wait for a repo maintainer to review your changes. Once they are satisfied, they will <ahref="#buildScript">build your repo </a>. This will create a PR into your branch.</li>
30
-
<li>Review the PR. It should contain the icon versions of your svgs. Accept the changes if you are satisfied</li>
31
-
<li>Once you accept the changes, a maintainer will accept your PR into the repo.</li>
29
+
<li>Wait for a repo maintainer to review your changes. They will run a script to check your icons. </li>
30
+
<li>If there are no issue, they will accept your PR into the repo. Else, they will let you know and give you a chance to fix it.</li>
32
31
</ol>
33
32
34
33
<hr>
@@ -64,6 +63,8 @@ Some icons are really simple (like the Apple one), so the original version can b
64
63
</li>
65
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>
66
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>
67
68
</ul>
68
69
69
70
<hr>
@@ -72,8 +73,6 @@ Some icons are really simple (like the Apple one), so the original version can b
72
73
<li>Each icon has its own folder located in the <code>icons</code> folder</li>
73
74
<li>Each icon folder contains one <code>.eps</code> file and as many <code>.svg</code> files as versions available</li>
74
75
<li>The <code>.eps</code> file contains all available versions of an icon. Each version is contained in a 128px by 128px artboard</li>
75
-
<li>Each <code>.svg</code> file contains one version of an icon in a <code>0 0 128 128</code> viewbox</li>
76
-
<li>The naming convention for the svg file is the following: <code>(icon name)-(original|plain|line)-(wordmark)</code></li>
77
76
</ul>
78
77
79
78
<hr>
@@ -158,6 +157,7 @@ As an example, let's assume you have created the svgs for Amazon Web Services an
158
157
"font": [ // here are the versions that will be used to create icons
159
158
"original", // original is simple enough to be used as plain
160
159
"plain-wordmark",
160
+
// note that the alias "plain" is not listed here. It must be listed in the `aliases` attribute
161
161
]
162
162
},
163
163
"color": "#F7A80D", // note the '#' character
@@ -232,9 +232,13 @@ As an example, let's assume you have created the svgs for Amazon Web Services an
232
232
<hr>
233
233
<h2id='buildScript'>Regarding The Build Script</h2>
234
234
<p>To make adding icons easier for repo maintainers, we rely on GitHub Actions, Python, Selenium, and Gulp to automate our tasks.</p>
235
-
<p>So far, the tasks that we have automated are:</p>
235
+
<p>So far, the tasks in the build script are:</p>
236
236
<ul>
237
237
<li>Upload svgs to <ahref="https://icomoon.io/app/#/select">icomoon.io</a> and get the icons back. For details, see <ahref="https://github.com/devicons/devicon/issues/252"> the original disscussion</a>, <ahref="https://github.com/devicons/devicon/pull/268">this PR that introduce the feature</a> and <ahref="https://github.com/devicons/devicon/issues/300">the final changes to it.</a></li>
238
238
<li>Build, combine, and minify CSS files. For details, see <ahref="https://github.com/devicons/devicon/pull/290">this</a></li>
239
+
</ul>
240
+
<p>There are also other tasks that we are automating, such as:</p>
241
+
<ul>
239
242
<li>Ensure code quality is up to standard</li>
243
+
<li>Upload svgs to <ahref="https://icomoon.io/app/#/select">icomoon.io</a> and take a screenshot for check.
0 commit comments