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

draft contribution guidelines for submitting and requesting icons

Browse Source
This commit is contained in:
Clemens Bastian 2020-06-08 22:33:06 +02:00 committed by GitHub
parent 022008fdc7
commit 72d7b0884b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
CONTRIBUTING.md
View File

@ -1,30 +1,48 @@
# Contributing to Devicon
First of all, thanks for taking the time to contribute!
These are not rules, just guidelines that you can follow in order to keep the repository as clean as possible. But if you don't have time to follow all of it, no worries, just create a pull request and I'll make the modifications myself if needed.
And if you think there is a better way to organize this repo, please do not hesitate to share your point of view.
## Submitting icon(s)
Each icon comes in different "versions":
- original
- original-wordmark
- plain
- plain-wordmark
- line
- line-wordmark
This is not mandatory, an icon can only have 1 or 2 versions available. Just keep in mind that the minimum is 1 and the maximum 6 (for now).
The plain and line versions (with or without wordmark) are designed to be available in the final icon font. So they need to stay as simple as possible (one color and ensure that the paths are united before to export to svg). You can use a service like [compressor](https://compressor.io/) or [SVG Editor](https://petercollingridge.appspot.com/svg-editor) in order to optimize the svg file.
<h1>Contributing to Devicon</h1>
<p>
First of all, thanks for taking the time to contribute! This project can only grow and live by your countless contributions. To keep this project maintable we developed some guidelines for contributions.
</p>
<h2>Submitting icon</h2>
<ul>
<li>Create a separated pull request for each icon (no matter how many variations)</li>
<li>Include the name of the icon in the pull request f.e. "new icon: html5 (original, plain, line)"</li>
<li>optional: Add a image of the new icon(s) to the description of the pull request</li>
<li>optional: Reference the issues regarding the new icon</li>
</ul>
<h3>Icon formats and naming conventions</h3>
<p>Each icon comes in different variantions:</p>
<ul>
<li>original</li>
<li>original-wordmark</li>
<li>plain</li>
<li>plain-wordmark</li>
<li>line</li>
<li>line-wordmark</li>
</ul>
<p>
This is not mandatory, an icon can only have one or two variations available. Just keep in mind that the minimum is 1 and the maximum 6 (for now).
</p>
<p>
The plain and line variations (with or without wordmark) are designed to be available in the final icon font. So they need to stay as simple as possible (one color and ensure that the paths are united before to export to svg). You can use a service like <a href="https://compressor.io/">compressor</a> or <a href="https://petercollingridge.appspot.com/svg-editor">SVG Editor</a> in order to optimize the svg file.
</p>
<p>
The original versions are only available in svg format, so they do not need to be as simple and they can contain numerous colors.
</p>
<p>
Some icons are really simple (like the apple one), so the original version can be used for the icon font. In this case, I'll add an alias so they can be found with the "original" or "plain" naming convention.
##### Organizational guidelines:
- Each icon has his own folder located in the "icons" folder.
- Each icon folder contains one .eps file and as many .svg files as versions available.
- The .eps file contains all available versions of an icon. Each version is contained in a 128px by 128px artboard.
- Each .svg file contains one version of an icon in a "0 0 128 128" viewbox
- The naming convention for the svg file is the following: (icon name)-(original/plain/line)-(wordmark)
</p>
<h3>Organizational guidelines</h3>
<ul>
<li>Each icon has his own folder located in the "icons" folder</li>
<li>Each icon folder contains one .eps file and as many .svg files as versions available</li>
<li>The .eps file contains all available versions of an icon. Each version is contained in a 128px by 128px artboard</li>
<li>Each .svg file contains one version of an icon in a "0 0 128 128" viewbox</li>
<li>The naming convention for the svg file is the following: (icon name)-(original/plain/line)-(wordmark)</li>
</ul>
<h2>Requesting a icon</h2>
<p>When you want to request a new icon please feel free to create a issue following some simple guidelines:</p>
<ul>
<li>Search for other issues already requesting the icon</li>
<li>Create an issue naming it "Icon request: <i>name-of-the-icon</i>"; please create separated issues for each icon</li>
<li>optional: Include links where the icon can be found</li>
</ul>