From 1b018fb1774bfef35cb84430e37b4a93d228bc3b Mon Sep 17 00:00:00 2001 From: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com> Date: Wed, 30 Jun 2021 02:41:03 -0700 Subject: [PATCH] Update CONTRIBUTING.md (#694) * Update CONTRIBUTING.md * Apply suggestions from code review Co-authored-by: David Leal * Update CONTRIBUTING * Update folder name rule in CONTRIBUTING. Include vuestorefront fix Co-authored-by: David Leal Co-authored-by: Clemens Bastian <8781699+amacado@users.noreply.github.com> --- CONTRIBUTING.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48ddf5ba..5c9cffc0 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,13 @@ 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 +74,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 them.
    • @@ -155,15 +156,15 @@ 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.

    • Organizational Guidelines