diff --git a/.github/workflows/post_check_svgs_comment.yml b/.github/workflows/post_check_svgs_comment.yml index cce4eba31..25dcacf68 100644 --- a/.github/workflows/post_check_svgs_comment.yml +++ b/.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 - uses: jungwinter/comment@v1 # let us comment on a specific PR - if: success() && steps.err_message_reader.outputs.content == '1' - env: - MESSAGE: | - Hi! - I'm Devicons' SVG-Checker Bot and everything looks great. Good job! + # - name: Comment on the PR about the result - Success + # uses: jungwinter/comment@v1 # let us comment on a specific PR + # if: success() && steps.err_message_reader.outputs.content == '1' + # env: + # MESSAGE: | + # Hi! + # I'm Devicons' SVG-Checker Bot and everything looks great. Good job! - Have a nice day, - SVG-Checker Bot :grin: - with: - type: create - issue_number: ${{ steps.pr_num_reader.outputs.content }} - token: ${{ secrets.GITHUB_TOKEN }} - body: ${{ env.MESSAGE }} + # Have a nice day, + # SVG-Checker Bot :grin: + # with: + # type: create + # issue_number: ${{ steps.pr_num_reader.outputs.content }} + # token: ${{ secrets.GITHUB_TOKEN }} + # 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() diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89b141f32..e3afaf9e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,14 +22,15 @@ First of all, thanks for taking the time to contribute! This project can only gr

Terms

Here are some terms that we will use in this repo:

    -
  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. -
  2. "SVG/.svg" refers to the svg versions of the Icons.
    3. -
  3. "icons" (lowercase) refers to the font icon versions of the Icons.
    4. +
  4. "Technology" is used to describe a software, libraries, tool, etc...
    5. +
  5. "Icon" refers to the svgs and icons version of a technology as a whole. +
  6. "SVG/svg" refers to the svg versions of the Icons.
    7. +
  7. "icon" (lowercase) refers specficially to the font icon versions of the Icons.

Overview on Submitting Icons

-

Here is an overview of what you have to do to submit your icons to the repo.

+

Here is what you have to do to submit your icons to the repo.

  1. Create the svgs for each svg versions that you have
  2. Put the svgs of each Icon into its own folders in /icons
    3. @@ -44,6 +45,13 @@ First of all, thanks for taking the time to contribute! This project can only gr

    Versions and Naming Conventions

    +

    For the technology name, make the file and folder name lowercase and concatenate them. For example:

    + +

    Each icon/svg can come in different versions. So far, we have:

    @@ -75,7 +82,7 @@ First of all, thanks for taking the time to contribute! This project can only gr

    Before you submit your logos/svgs, please ensure that they meet the following standard: