From 33c56b259ee04cb1cc233b25a39893131d5c85e3 Mon Sep 17 00:00:00 2001 From: Thomas Bui Date: Wed, 30 Dec 2020 13:36:05 -0800 Subject: [PATCH] Made eps requirements optional and clear up some terms --- .github/workflows/peek_icons.yml | 3 --- CONTRIBUTING.md | 15 ++++++++------- 2 files changed, 8 insertions(+), 10 deletions(-) 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
  1. "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
  2. "SVG/.svg" refers to the svg versions of the Icons.
    3. -
  3. "icons" refers to the icon versions of the Icons.
    4. +
  4. "icons" (lowercase) refers to the font icon versions of the Icons.
@@ -69,7 +69,7 @@ First of all, thanks for taking the time to contribute! This project can only gr The original version are only available in svg format, so they do not need to be as simple and can contain numerous colors.
  • - 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 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.
    • @@ -91,15 +91,16 @@ First of all, thanks for taking the time to contribute! This project can only gr

    Organizational Guidelines

    Updating the devicon.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 } ] }