From 0c4a0f59b5d6d047dc998c9987a311e4fa6f60d5 Mon Sep 17 00:00:00 2001 From: Thomas Bui Date: Thu, 24 Jun 2021 10:49:58 -0700 Subject: [PATCH 1/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ba3ec1660..05f87b4a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
  • Terms
  • What Icons Do We Accept?
  • Requesting An Icon
    • -
  • Overview on Submitting Icon (start here if new)
    • +
  • Overview on Submitting Icon (start here if new to contributing)
  • Naming Conventions
  • SVG Standards
  • Organizational Guidelines
    • @@ -53,12 +53,12 @@ First of all, thanks for taking the time to contribute! This project can only gr

    Requesting an Icon

    -

    To request an icon, you can create an issue in the repository. Please follow these simple guidelines:

    +

    To request an icon, please create an issue in the repository and follow these guidelines:

    @@ -73,7 +73,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
  • Optional: Reference the issues regarding the new icon.
  • Some bots will check your SVGs. If there are any errors, please fix them as instructed.
  • Wait for a maintainer to review your changes. They will run the peek-bot to check your icons.
    • -
  • If there are no issues, they will run the optimize-bot on your SVGs then merge it using squash merging. If there are any problems, they will let you know and give you a chance to fix it.
    • +
  • If there are no issues, they will merge it using squash merging. If there are any problems, they will let you know and give you a chance to fix it.
    • @@ -155,8 +155,6 @@ First of all, thanks for taking the time to contribute! This project can only gr
  • Each .svg file contains one version of an icon in a 0 0 128 128 viewbox. You can use a service like resize-image for scaling the SVG.
  • The icon's strokes and texts must be fills. This is to satisfy our conversion website's requirements.
    • -
  • The SVG element does not need the height and width attributes. However, if you do use it, ensure their values are either "128" or "128px". Ex: height="128"
    • -
  • Optimize/compress your SVGs. You can use a service like compressor or SVG Editor.
  • Each .svg must use the fill attribute instead of using classes for colors. This is to prevent class name clashing when using inline SVG. See here for more details.
    • From b331527602c134f82f77503874e092d2d087f136 Mon Sep 17 00:00:00 2001 From: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com> Date: Fri, 25 Jun 2021 21:58:45 -0700 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: David Leal --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 05f87b4a0..37d8343b3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,7 @@ First of all, thanks for taking the time to contribute! This project can only gr

    Requesting an Icon

    -

    To request an icon, please create an issue in the repository and follow these guidelines:

    +

    To request an icon, please create an issue in the repository, and follow these guidelines:

    From b440f701918c3218ed0d15c67ed38a3068303a70 Mon Sep 17 00:00:00 2001 From: Thomas Bui Date: Fri, 25 Jun 2021 23:12:37 -0700 Subject: [PATCH 4/4] Update folder name rule in CONTRIBUTING. Include vuestorefront fix --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2879c0a9..f70826f65 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -162,7 +162,9 @@ First of all, thanks for taking the time to contribute! This project can only gr

    Organizational Guidelines

      -
    • Each icon has its own folder located in the icons folder. All the .svg files for the Icon must go in the same folder
      • +
    • Each icon has its own folder located in the icons folder.
      • +
    • The folder name must matches the name value uses for the SVG files. Ex: `react-original.svg` should go inside a `react` folder, `microsoftsqlserver` icons should go inside a `microsoftsqlserver` folder.
      • +
    • All the .svg files for the Icon must go in the same folder.
    • Optional: Each folder may contain one .eps file. The .eps file should contains all available versions of an icon. Each version is contained in a 128px by 128px artboard