From f07f37970333d4fbc8ce3327cd1656bba2fa90e3 Mon Sep 17 00:00:00 2001 From: Clemens Bastian <8781699+amacado@users.noreply.github.com> Date: Sun, 10 Jan 2021 16:25:42 +0100 Subject: [PATCH] Add guideline about squash merging As the result of discussion #470 update guidelines with squash merging --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01f6ace7..f560885d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,12 +32,12 @@ First of all, thanks for taking the time to contribute! This project can only gr
  • Create the svgs for each svg versions that you have
  • 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) for each Icon.
    • +
  • Create a separated pull request (PR) towards the develop branch for each Icon.
  • Include the name of the Icon in the pull request title in this format: new icon: Icon name (versions)
  • Optional: Add images of the new svg(s) to the description of the pull request. This would help speed up the review process
  • Optional: Reference the issues regarding the new icon.
  • Wait for a maintainer to review your changes. They will run a script to check your icons.
    • -
  • If there are no issue, they will accept your PR into the repo. Else, they will let you know and give you a chance to fix it.
    • +
  • If there are no issues, they will accept your pull request and merge it using squash merging. If there are any problems, they will let you know and give you a chance to fix it.
    • @@ -259,4 +259,4 @@ As an example, let's assume you have created the svgs for Redhat and Amazon Web
  • Ensure code quality is up to standard
  • Upload svgs to icomoon.io and take a screenshot to check that it looks good.
  • Comment on the PR so maintainers don't have to manually upload icon result.
    • - \ No newline at end of file +