From 47f30c2cec450fe673c041826e9563564432f279 Mon Sep 17 00:00:00 2001 From: Thomas Bui Date: Mon, 23 Aug 2021 11:48:29 -0700 Subject: [PATCH] Update the docs for CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77d556562..16beec641 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,8 @@ First of all, thanks for taking the time to contribute! This project can only gr
  • Example of Submitting An Icon
  • Updating an Icon
  • Maintainer/Reviewer/Teams
  • -
  • Our Workflows: how they work and their issues
  • +
  • Our Workflows: how they work
  • +
  • Common Bugs and Solutions
  • Discord server
  • Release strategy, conventions, preparation and execution
  • @@ -411,6 +412,8 @@ As an example, let's assume you have created the SVGs for Redhat and Amazon Web
  • Creating a list of features that was added since last release. See this discussion for inception and limitations.
  • +
    +

    Common Bugs and Solutions

    There are some bugs that the build scripts might run into. Listed below are the common ones and their solutions

    1. No connection could be made because the target machine actively refused it. (os error 10061) @@ -437,7 +440,7 @@ As an example, let's assume you have created the SVGs for Redhat and Amazon Web
      • See this PR's peek result.
      • This is caused by a bug in Icomoon's parser (see this).
      • -
      • Solution: Luckily this is an extremely rare case. Try remake the SVG in a different way (using different paths/shapes) and test using Icomoon.
      • +
      • Solution: Luckily this is an extremely rare case. Try remaking the SVG in a different way (using different paths/shapes). If your text/paths are joined with another object (say, the logo), try splitting them into individual paths (see this PR). You can always test using Icomoon to see if your fix works.