From 210252927f6418125ec3590a29cf8006f4d8701f Mon Sep 17 00:00:00 2001 From: Thomas Bui Date: Fri, 13 Aug 2021 12:24:32 -0700 Subject: [PATCH 1/3] Update CONTRIBUTING --- CONTRIBUTING.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c9cffc0d..b4bce7c41 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,8 +14,9 @@ First of all, thanks for taking the time to contribute! This project can only gr
  • Organizational Guidelines
  • Updating the devicon.json
  • Example of Submitting An Icon
    • +
  • Updating an Icon
  • Maintainer/Reviewer/Teams
    • -
  • The Build Script: how it works and its quirks
    • +
  • Our Workflows: how they work and their issues
  • Discord server
  • Release strategy, conventions, preparation and execution
    • @@ -70,12 +71,14 @@ First of all, thanks for taking the time to contribute! This project can only gr
  • Put the SVGs of each Icon into its own folders in /icons
  • Update the devicon.json to include the new Icon
  • Create a separated pull request (PR) towards the develop branch for each Icon.
    • +
  • Fill out the info as stated in the PR template.
  • Include the name of the Icon in the pull request title in this format: new icon: Icon name (versions)
    • -
  • Optional: Reference the issues regarding the new icon.
    • +
  • Optional: Reference the issues regarding the new icon and label the PR `feature: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 merge it using squash merging. If there are any problems, they will let you know, and give you a chance to fix them.
    • +

    Note: Due to our recent bot upgrades, icon contributors don't have to optimize/minify their SVGs anymore!

    Versions and Naming Conventions

    @@ -326,6 +329,26 @@ As an example, let's assume you have created the SVGs for Redhat and Amazon Web
  • For the rest of the steps, you can follow Overview on Submitting Icon
    • +
    +

    Updating an Icon

    +

    + Sometimes, a company will update their logo or someone spotted an error in the SVG/icon that needs to be fixed. This means the current icon in our repository might need an update. The steps to do this is simple: +

    +
      +
    1. + Create a new commit to fix the SVGs. +
      2. +
    2. + Open a pull request to `develop` branch. +
      3. +
    3. + IMPORTANT: name the pull request update icon: icon-name (versions). Basically, follow the Overview on Submitting Icon but replace the new with update in name of request with the above. +
      4. +
    4. + Follow the rest of the steps as laid out in Overview on Submitting Icon. +
      5. +
    +

    Maintainer/Reviewer/Teams

    @@ -410,13 +433,6 @@ As an example, let's assume you have created the SVGs for Redhat and Amazon Web

  • Solution: Ensure the name of the PR follows the convention.
    • -
  • Peek bot fails when an icon is updated - -
  • Icon created by Icomoon contains strange lines that aren't in the SVG
    • From ee579d4e872d499cd8e4119d4fc4a9036ca73285 Mon Sep 17 00:00:00 2001 From: Thomas Bui Date: Fri, 13 Aug 2021 12:32:53 -0700 Subject: [PATCH 2/3] Update README --- README.md | 41 ++++++++++++++++++++++++++++++++++------- 1 file changed, 34 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3cdf462c2..499bff539 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,8 @@
  • Getting started
  • Requesting icon
  • Contributing
    • +
  • Discord server
    • +
  • develop vs master
  • Stale pull requests
  • Go build yourself
    • @@ -159,19 +161,44 @@ Add css rules in your stylesheet

    Contributing

    - We are happy for every contribution. Please have a look at our contribution guidelines - to see how you can contribute to this project. + We are happy for every contribution, whether it's new icons, features, or maintainers. Please have a look at our contribution guidelines to see how you can contribute to this project.

    -

    Stale pull requests

    +

    Discord server

    -After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited. +We are running a Discord server. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ. +Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.

    -

    Discord server

    +

    develop vs master

    -We are running a Discord server. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ. -Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub. +All official releases shall be in master. Any updates in between (icons, features, etc.) will be kept in develop. +

    +develop contains: +
      +
    • + Latest SVGs (non-optimized). +
      • +
    • + No icons for the latest SVGs. These will be build at every release. +
      • +
    • + Experimental changes. +
      • +
    +master contains: +
      +
    • + Latest official release, which contains the release' SVGs and icons. +
      • +
    • + Official tested changes. +
      • +
    + +

    Stale pull requests

    +

    +After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited.

    Go build yourself

    From 65efc429667f969229c730bf0fee50ea01be67d6 Mon Sep 17 00:00:00 2001 From: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com> Date: Fri, 13 Aug 2021 14:22:04 -0700 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: David Leal --- CONTRIBUTING.md | 4 ++-- README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b4bce7c41..77d556562 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -339,7 +339,7 @@ As an example, let's assume you have created the SVGs for Redhat and Amazon Web Create a new commit to fix the SVGs.
  • - Open a pull request to `develop` branch. + Open a pull request based on the `develop` branch.
  • IMPORTANT: name the pull request update icon: icon-name (versions). Basically, follow the Overview on Submitting Icon but replace the new with update in name of request with the above. @@ -477,7 +477,7 @@ We are running a Discord server. You can go here to talk, discuss, and more with Take the PRs/commits as a guideline. It's also a good idea to mention and thank all contributions who participated in the release (take description of #504 as an example).
  • - We now have a script that will do this for us. Check the `build-bot`'s PR message in the last step. There should be a section where it displays the features that has been added in the release. You can copy the markdown there and use it for the release message. + We now have a script that will do this for us. Check the `build-bot`'s PR message in the last step. There should be a section where it displays the features that have been added to the release. You can copy the markdown there and use it for the release message.
    • diff --git a/README.md b/README.md index 499bff539..4fef76480 100644 --- a/README.md +++ b/README.md @@ -189,7 +189,7 @@ All official releases shall be in master. Any updates in between (i master contains:
    • - Latest official release, which contains the release' SVGs and icons. + Latest official release, which contains the SVGs and icons.
    • Official tested changes.