Check svg now fails if there's error and updated CONTRIBUTING

.github/workflows/post_check_svgs_comment.yml

@@ -35,21 +35,21 @@ jobs:
         with:
           path: ./svg_err_messages/svg_err_messages.txt
 
-      - name: Comment on the PR about the result - Success
+      # - name: Comment on the PR about the result - Success
-        uses: jungwinter/comment@v1 # let us comment on a specific PR
+      #   uses: jungwinter/comment@v1 # let us comment on a specific PR
-        if: success() && steps.err_message_reader.outputs.content == '1'
+      #   if: success() && steps.err_message_reader.outputs.content == '1'
-        env:
+      #   env:
-          MESSAGE: |
+      #     MESSAGE: |
-            Hi!
+      #       Hi!
-            I'm Devicons' SVG-Checker Bot and everything looks great. Good job!
+      #       I'm Devicons' SVG-Checker Bot and everything looks great. Good job!
 
-            Have a nice day, 
+      #       Have a nice day, 
-            SVG-Checker Bot :grin:
+      #       SVG-Checker Bot :grin:
-        with:
+      #   with:
-          type: create
+      #     type: create
-          issue_number: ${{ steps.pr_num_reader.outputs.content }}
+      #     issue_number: ${{ steps.pr_num_reader.outputs.content }}
-          token: ${{ secrets.GITHUB_TOKEN }}
+      #     token: ${{ secrets.GITHUB_TOKEN }}
-          body: ${{ env.MESSAGE }}
+      #     body: ${{ env.MESSAGE }}
 
       - name: Comment on the PR about the result - SVG Error
         uses: jungwinter/comment@v1 # let us comment on a specific PR
@@ -79,6 +79,11 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           body: ${{ format(env.MESSAGE, steps.err_message_reader.outputs.content) }}
 
+      # if we posted error messages before, we fail this entire workflow
+      - name: Fail workflow is there is an error.
+        uses: cutenode/action-always-fail@v1.0.1
+        if: success() && (steps.err_message_reader.outputs.content != '0' && steps.err_message_reader.outputs.content != '1')
+
       - name: Comment on the PR about the result - Failure
         uses: jungwinter/comment@v1 # let us comment on a specific PR
         if: failure() 

CONTRIBUTING.md

@@ -29,7 +29,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
 
 <hr>
 <h2 id="overview">Overview on Submitting Icons</h2>
-<p>Here is an overview of what you have to do to submit your icons to the repo.</p>
+<p>Here is what you have to do to submit your icons to the repo.</p>
 <ol>
   <li>Create the svgs for each <a href="#versionNaming"> svg versions </a> that you have</li>
   <li>Put the svgs of each Icon into its own folders in <code>/icons</code> </li>
@@ -44,6 +44,15 @@ First of all, thanks for taking the time to contribute! This project can only gr
 
 <hr>
 <h2 id='versionNaming'>Versions and Naming Conventions</h2>
+<p>For the technology name, make the file and folder name lowercase and concatenate them. For example:</p>
+<ul>
+  <li>AngularJS becomes <code>angularjs</code> or just <code>angular</code></li>
+  <li>Amazon Web Services becomes <code>amazonwebservices</code></li>
+  <li>Microsoft SQL Server becomes <code>microsoftsqlserver</code></li>
+  <li><i>Note:</i>For JS libraries, you can also remove the "js" part if it's still recognizable.</li>
+</ul>
+<br>
+
 <p>Each icon/svg can come in different versions. So far, we have:</p>
 <ul>
   <li><b>original</b>: the original logo. Can contain multiple colors. <a href="https://github.com/devicons/devicon/blob/master/icons/amazonwebservices/amazonwebservices-original.svg"> Example </a> </li>