diff --git a/.github/workflows/peek_icons.yml b/.github/workflows/peek_icons.yml index 140221fe..9ab45ce6 100644 --- a/.github/workflows/peek_icons.yml +++ b/.github/workflows/peek_icons.yml @@ -9,9 +9,6 @@ jobs: runs-on: windows-2019 steps: - uses: actions/checkout@v2 - with: - ref: ${{ github.head_ref }} - repository: ${{ github.event.pull_request.head.repo.full_name}} - name: Setup Python v3.8 uses: actions/setup-python@v2 with: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 46922fbe..92eaa5fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
.svg
" refers to the svg
versions of the Icons.devicon.json
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.
+ 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 devicon.json
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.
icons
folder.eps
file and as many .svg
files as versions available (at the minimum one .svg
file).eps
file contains all available versions of an icon. Each version is contained in a 128px by 128px artboardicons
folder.eps
file.eps
file should contains all available versions of an icon. Each version is contained in a 128px by 128px artboard.svg
files for the Icondevicon.json
- Before you open a PR into Devicon, you'd have to update the devicon.json
. This is essential for our build script to work and to document your work.
+ Before you open a PR into Devicon, you must update the devicon.json
. This is essential for our build script to work and to document your work.
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 { "base": "original", // here is the base version that we will upload to Icomoon "alias": "plain" // this is its alias. Our script will create a reference so users can search using "original" or "plain" for this icon - // 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 + // 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 } ] }