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
- name: Comment on the PR about the result - Failure
77
-
if: failure() || cancelled()
84
+
if: failure() || env.PEEK_STATUS == 'failure'
78
85
uses: jungwinter/comment@v1 # let us comment on a specific PR
79
86
env:
80
87
MESSAGE: |
@@ -88,7 +95,7 @@ jobs:
88
95
- Your icon information has been added to the `devicon.json` as seen [here](https://github.com/devicons/devicon/blob/master/CONTRIBUTING.md#updateDevicon)
89
96
- Your PR title follows the format seen [here](https://github.com/devicons/devicon/blob/master/CONTRIBUTING.md#overview)
90
97
91
-
Once everything is fixed, I will try. If I still fail (sorry!), the maintainers will investigate further.
98
+
I will retry once everything is fixed. If I still fail (sorry!) or there are other erros, the maintainers will investigate.
we noticed that this PR has been inactive for a while now. If there are any changes which are suitable for our repository,
15
+
we would love to have it. It would be great if you can continue with this PR, but if you cannot, we might fork your changes and merge the changes ourselves.
16
+
17
+
Since GitHub tracks contributions by commits, you will still be credited.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+22-8Lines changed: 22 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
<h1>Contributing to Devicon</h1>
2
2
<p>
3
-
First of all, thanks for taking the time to contribute! This project can only grow and live by your countless contributions. To keep this project maintable we developed some guidelines for contributions.
3
+
First of all, thanks for taking the time to contribute! This project can only grow and live by your countless contributions. To keep this project maintainable, we have developed some guidelines for our contributors.
4
4
</p>
5
5
6
6
<h2>Table of Content</h2>
@@ -15,20 +15,22 @@ First of all, thanks for taking the time to contribute! This project can only gr
15
15
<li><ahref="#requestingIcon">Requesting An Icon</a></li>
<p>Here are some terms that we will use in this repo: </p>
23
24
<ol>
24
-
<li>"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</li>
25
-
<li>"SVG/<code>.svg</code>" refers to the <code>svg</code> versions of the Icons.</li>
26
-
<li>"icons" (lowercase) refers to the font icon versions of the Icons.</li>
25
+
<li>"Technology" is used to describe a software, libraries, tool, etc...</li>
26
+
<li>"Icon" refers to the svgs and icons version of a technology as a whole.</i>
27
+
<li>"SVG/<code>svg</code>" refers to the <code>svg</code> versions of the Icons.</li>
28
+
<li>"icon" (lowercase) refers specficially to the font icon versions of the Icons.</li>
27
29
</ol>
28
30
29
31
<hr>
30
32
<h2id="overview">Overview on Submitting Icons</h2>
31
-
<p>Here is an overview of what you have to do to submit your icons to the repo.</p>
33
+
<p>Here is what you have to do to submit your icons to the repo.</p>
32
34
<ol>
33
35
<li>Create the svgs for each <ahref="#versionNaming"> svg versions </a> that you have</li>
34
36
<li>Put the svgs of each Icon into its own folders in <code>/icons</code> </li>
@@ -43,6 +45,13 @@ First of all, thanks for taking the time to contribute! This project can only gr
43
45
44
46
<hr>
45
47
<h2id='versionNaming'>Versions and Naming Conventions</h2>
48
+
<p>For the technology name, make the file and folder name lowercase and concatenate them. For example:</p>
49
+
<ul>
50
+
<li>AngularJS becomes <code>angularjs</code> or just <code>angular</code></li>
51
+
<li>Amazon Web Services becomes <code>amazonwebservices</code></li>
52
+
<li>Microsoft SQL Server becomes <code>microsoftsqlserver</code></li>
53
+
</ul>
54
+
46
55
<p>Each icon/svg can come in different versions. So far, we have:</p>
47
56
<ul>
48
57
<li><b>original</b>: the original logo. Can contain multiple colors. <ahref="https://github.com/devicons/devicon/blob/master/icons/amazonwebservices/amazonwebservices-original.svg"> Example </a> </li>
@@ -65,7 +74,6 @@ First of all, thanks for taking the time to contribute! This project can only gr
65
74
</li>
66
75
<li>
67
76
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 <code>devicon.json</code> 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.
68
-
69
77
</li>
70
78
</ul>
71
79
@@ -74,15 +82,15 @@ First of all, thanks for taking the time to contribute! This project can only gr
74
82
<p>Before you submit your logos/svgs, please ensure that they meet the following standard:</p>
75
83
<ul>
76
84
<li>The background must be transparent.</li>
77
-
<li>The svg name follows this convention: <code>(Icon name)-(original|plain|line)(-wordmark?).</code></li>
85
+
<li>The svg name follows this convention: <code>(Technology name)-(original|plain|line)(-wordmark?).</code></li>
78
86
<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. We will strip the color when turning it into icons so they can have any color.
79
87
</li>
80
88
<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>
81
89
<li>The icon's strokes and texts must be fills. This is to satisfy our conversion website's <ahref="https://icomoon.io/#docs/stroke-to-fill">requirements.</a></li>
82
90
<li>Each <code>.svg</code> file contains one version of an icon in a <code>0 0 128 128</code> viewbox. You can use a service like <ahref="https://www.iloveimg.com/resize-image/resize-svg">resize-image</a> for scaling the svg.</li>
83
91
<li>The <code>svg</code> element does not need the <code>height</code> and <code>width</code> attributes. However, if you do use it, ensure their values are either <code>"128"</code> or <code>"128px"</code>. Ex: <code>height="128"</code></li>
84
92
<li>Each <code>.svg</code> must use the <code>fill</code> attribute instead of using <code>classes</code> for colors. See <ahref="https://github.com/devicons/devicon/issues/407">here</a> for more details.</li>
85
-
<li>The naming convention for the svg file is the following: <code>(Icon name)-(original|plain|line)(-wordmark?).</code></li>
93
+
<li>The naming convention for the svg file is the following: <code>(Technology name)-(original|plain|line)(-wordmark?).</code></li>
86
94
</ul>
87
95
88
96
<hr>
@@ -299,3 +307,9 @@ As an example, let's assume you have created the svgs for Redhat and Amazon Web
299
307
<li>Comment on the PR so maintainers don't have to manually upload icon result.</li>
300
308
<li>Publishing a new release to <ahref="https://www.npmjs.com/package/devicon">npm</a>; See <ahref="https://github.com/devicons/devicon/issues/288">#288</a></li>
301
309
</ul>
310
+
311
+
<h2id="discordServer">Discord server</h2>
312
+
<p>
313
+
We are running a Discord server. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ. If you don't have a GitHub account but want to suggest ideas or new icons, you can do that here in our Discord channel.
314
+
<b>Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.<b>
@@ -155,6 +156,17 @@ Add css rules in your stylesheet
155
156
to see how you can contribute to this project.
156
157
</p>
157
158
159
+
<h2id="stale-prs">Stale pull requests</h2>
160
+
<p>
161
+
After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited.
162
+
</p>
163
+
164
+
<h2id="discord-server">Discord server</h2>
165
+
<p>
166
+
We are running a Discord server. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ.
167
+
<b>Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.<b>
168
+
</p>
169
+
158
170
<h2id="build-yourself">Go build yourself</h2>
159
171
<p>
160
172
Feel free to follow those steps when you want to build the font
0 commit comments