mirror/devicon
1
0
Fork 0
mirror of https://github.com/konpa/devicon.git synced 2025-01-17 13:38:15 +01:00
Code Issues Releases Wiki Activity

Add guideline about squash merging

Browse Source 
As the result of discussion #470 update guidelines with squash merging
This commit is contained in:
Clemens Bastian 2021-01-10 16:25:42 +01:00 committed by GitHub
parent 340e85ee25
commit f07f379703
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -32,12 +32,12 @@ First of all, thanks for taking the time to contribute! This project can only gr
<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>
<li><a href="#updateDevicon">Update the <code>devicon.json</code> to include the new Icon</a> </li>
<li>Create a separated pull request (PR) for each Icon. </li>
<li>Create a separated pull request (PR) towards the <code>develop</code> branch for each Icon.</li>
<li>Include the name of the Icon in the pull request title in this format: <code>new icon: <i>Icon name</i> (<i>versions</i>)</code> </li>
<li><i>Optional</i>: Add images of the new svg(s) to the description of the pull request. This would help speed up the review process </li>
<li><i>Optional</i>: Reference the issues regarding the new icon. </li>
<li>Wait for a maintainer to review your changes. They will run a script to check your icons.</li>
<li>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.</li>
<li>If there are no issues, they will accept your pull request and merge it using <a href="https://github.com/devicons/devicon/discussions/470">squash merging</a>. If there are any problems, they will let you know and give you a chance to fix it.</li>
</ol>
<hr>
@ -259,4 +259,4 @@ As an example, let's assume you have created the svgs for Redhat and Amazon Web
<li>Ensure code quality is up to standard</li>
<li>Upload svgs to <a href="https://icomoon.io/app/#/select">icomoon.io</a> and take a screenshot to check that it looks good.
<li>Comment on the PR so maintainers don't have to manually upload icon result.</li>
</ul>
</ul>