beenull/simple-icons
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update the Contributing Guidelines

Browse source 
- Remove dead link ("Labelling Issues")
- Use consistent Title Case for all titles
This commit is contained in:
Eric Cornelisesn 2020-02-28 11:37:13 +02:00
parent 407e9970eb
commit 3a4535ec78
1 changed files with 13 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
CONTRIBUTING.md
View file

@ -1,4 +1,4 @@
# Contributing To Simple Icons
# Contributing to Simple Icons
Simple Icons welcomes contributions and corrections. Before contributing, please make sure you have read the guidelines below. If you decide to contribute anything, please do the following:
@ -10,12 +10,11 @@ Simple Icons welcomes contributions and corrections. Before contributing, please
## Table of contents
* [Requesting An Icon](#requesting-an-icon)
* [Adding or Updating An Icon](#adding-or-updating-an-icon)
* [Labeling Issues](#labeling-issues)
* [Building Locally](#building-locally)
* [Requesting an Icon](#requesting-an-icon)
* [Adding or Updating an Icon](#adding-or-updating-an-icon)
* [Building the Website](#building-locally)
## Requesting An Icon
## Requesting an Icon
We welcome icon requests. Before you submit a new issue please make sure the icon:
@ -33,7 +32,7 @@ When submitting a request for a new or updated icon include helpful information
* **Issue Body:** Links to official sources for the brand's icon and colors (e.g. media kits, brand guidelines, SVG files etc.)
## Adding or Updating An Icon
## Adding or Updating an Icon
**Note**: If you decide to add an icon without requesting it first, the requirements above still apply.
@ -53,7 +52,7 @@ Working with an SVG version of the logo is best. In the absence of an SVG versio
For color, the brand's primary color should be used. The official color of a brand is usually found in their brand guidelines, media kits, or some of the other locations mentioned above. If no official color can be identified, use the brand's primary web color or the most prominent color in the logo itself (please indicate why you choose the particular color in your pull request). Simple Icons stores brand colors in the standard 6 character hexadecimal format.
### 2. Extract The Icon From The Logo
### 2. Extract the Icon from the Logo
There are many different tools for editing SVG files, some options include:
@ -72,7 +71,7 @@ Using your preferred tool you should:
1. Remove all colors. The icon should be monochromatic.
1. Export the icon as an SVG.
### 3. Optimize The Icon
### 3. Optimize the Icon
All icons in Simple Icons have been optimized with the [SVGO tool](https://github.com/svg/svgo). This can be done in one of two ways:
@ -87,7 +86,7 @@ All icons in Simple Icons have been optimized with the [SVGO tool](https://githu
* Leave the remaining settings untouched (or reset them with the button at the bottom of the settings).
* Click the download button.
### 4. Annotate The Icon
### 4. Annotate the Icon
Each icon in Simple Icons has been annotated with a number of attributes and elements to increase accessibility. These include:
@ -107,7 +106,7 @@ Here is _part of_ the svg for the Adobe Photoshop icon as an example:
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Adobe Photoshop icon</title>...</svg>
```
### 5. Check The Icon
### 5. Check the Icon
The final icon should:
@ -130,7 +129,7 @@ Here is the svg for the Adobe Photoshop icon as an example:
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Adobe Photoshop icon</title><path d="M0 .3v23.4h24V.3H0zm1 1h22v21.4H1V1.3zm4.8 4.48c0-.067.14-.116.224-.116.644-.033 1.588-.05 2.578-.05 2.772 0 3.85 1.52 3.85 3.466 0 2.54-1.842 3.63-4.102 3.63-.38 0-.51-.017-.775-.017v3.842c0 .083-.033.116-.115.116H5.916c-.083 0-.115-.03-.115-.113V5.78zm1.775 5.312c.23.016.412.016.81.016 1.17 0 2.27-.412 2.27-1.996 0-1.27-.786-1.914-2.122-1.914-.396 0-.775.016-.957.033v3.864zm8.607-1.188c-.792 0-1.056.396-1.056.726 0 .363.18.61 1.237 1.155 1.568.76 2.062 1.485 2.062 2.557 0 1.6-1.22 2.46-2.87 2.46-.876 0-1.62-.183-2.05-.43-.065-.033-.08-.082-.08-.165V14.74c0-.1.048-.133.114-.084.624.413 1.352.594 2.012.594.792 0 1.122-.33 1.122-.776 0-.363-.23-.677-1.237-1.205-1.42-.68-2.014-1.37-2.014-2.527 0-1.287 1.006-2.36 2.755-2.36.86 0 1.464.132 1.794.28.082.05.1.132.1.198v1.37c0 .083-.05.133-.15.1-.444-.264-1.1-.43-1.743-.43z"/></svg>
```
### 6. Update The JSON Data For SimpleIcons.org
### 6. Update the JSON Data for SimpleIcons.org
Icon metadata should be added to the `_data/simple-icons.json` file. Each icon in the array has three required values:
@ -199,7 +198,7 @@ If the SVG is sourced from:
In general, make sure the URL does not contain any tracking identifiers.
### 7. Create a pull request
### 7. Create a Pull Request
Once you've completed the previous steps, create a pull request to merge your edits into the *develop* branch.
@ -210,7 +209,7 @@ Once you've completed the previous steps, create a pull request to merge your ed
* Build and run the website locally using `$ jekyll serve`.
* Connect to the website in your browser via the "Server address" provided by the output of this command, e.g. `http://localhost:4000/`
## Building In Your Browser
## Building in Your Browser
Alternatively, you can build and run the website in a readily configured online workspace: