Skip to content

Commit 33c56b2

Browse files
committed
Made eps requirements optional and clear up some terms
1 parent b2d7fc7 commit 33c56b2

2 files changed

Lines changed: 8 additions & 10 deletions

File tree

.github/workflows/peek_icons.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ jobs:
99
runs-on: windows-2019
1010
steps:
1111
- uses: actions/checkout@v2
12-
with:
13-
ref: ${{ github.head_ref }}
14-
repository: ${{ github.event.pull_request.head.repo.full_name}}
1512
- name: Setup Python v3.8
1613
uses: actions/setup-python@v2
1714
with:

CONTRIBUTING.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
2222
<ol>
2323
<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>
2424
<li>"SVG/<code>.svg</code>" refers to the <code>svg</code> versions of the Icons.</li>
25-
<li>"icons" refers to the icon versions of the Icons.</li>
25+
<li>"icons" (lowercase) refers to the font icon versions of the Icons.</li>
2626
</ol>
2727

2828
<hr>
@@ -69,7 +69,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
6969
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.
7070
</li>
7171
<li>
72-
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. Note: this only applies to font icon versions only, not the SVG versions.
72+
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.
7373
7474
</li>
7575
</ul>
@@ -91,15 +91,16 @@ First of all, thanks for taking the time to contribute! This project can only gr
9191
<hr>
9292
<h2 id='orgGuidelines'>Organizational Guidelines</h2>
9393
<ul>
94-
<li>Each Icon has its own folder located in the <code>icons</code> folder</li>
95-
<li>Each Icon folder must contain one <code>.eps</code> file and as many <code>.svg</code> files as versions available (at the minimum one <code>.svg</code> file)</li>
96-
<li>The <code>.eps</code> file contains all available versions of an icon. Each version is contained in a 128px by 128px artboard</li>
94+
<li>Each icon has its own folder located in the <code>icons</code> folder</li>
95+
<li>Each folder <i>may</i> contain one <code>.eps</code> file</li> (optional)
96+
<li>The <code>.eps</code> file should contains all available versions of an icon. Each version is contained in a 128px by 128px artboard</li>
97+
<li>Each folder must contain all the <code>.svg</code> files for the Icon</li>
9798
</ul>
9899

99100
<hr>
100101
<h2 id='updateDevicon'> Updating the <code>devicon.json</code> </h2>
101102
<p>
102-
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.
103+
Before you open a PR into Devicon, you must update the <code>devicon.json</code>. This is essential for our build script to work and to document your work.
103104
</p>
104105
<p>
105106
Here is the object that each of your Icon must have:
@@ -214,7 +215,7 @@ As an example, let's assume you have created the svgs for Redhat and Amazon Web
214215
{
215216
"base": "original", // here is the base version that we will upload to Icomoon
216217
"alias": "plain" // this is its alias. Our script will create a reference so users can search using "original" or "plain" for this icon
217-
// note that you don't provide aliases for the svg version. If "original" is not a font version (i.e can't be made into a font), there's no need to provide it with a plain alias
218+
// note that you don't provide aliases for the svg version. If "original" can't be made into a font, there's no need to provide it with a plain alias
218219
}
219220
]
220221
}

0 commit comments

Comments
 (0)