edent-gh/SuperTinyIcons
1
0
Fork 0
forked from edent/SuperTinyIcons
Code Pull Requests Activity

update contributing guidelines (#356)

Browse Source
This commit is contained in:
Romain Dartigues
2019-10-31 14:48:02 +01:00
committed by Terence Eden
parent 425b7195a5
commit 35ed2931db
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@@ -9,14 +9,14 @@ Thanks for submitting or fixing an icon! Here is a helpful guide to what you nee
## New File ## New File
Filename should be `nameofservice.svg` - all in lower-case. Filename should be `nameofservice.svg` - all in lower-case.
If a special character must be used, please replace it with an underscore (no dot nor a dash).
Place the file in `/images/svg/` Place the file in `/images/svg/`
At a minimum, your icon needs these components: At a minimum, your icon needs these components:
``` ```svg
<svg <svg xmlns="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
aria-label="..." role="img" aria-label="..." role="img"
viewBox="0 0 512 512"><rect viewBox="0 0 512 512"><rect
width="512" height="512" width="512" height="512"
@@ -26,6 +26,11 @@ fill="#fff"/>...</svg>
Please keep the whitespace as-is. This makes viewing diffs easier. Please use UNIX line-endings `LF` rather than Windows-style `CRLF`. Please keep the whitespace as-is. This makes viewing diffs easier. Please use UNIX line-endings `LF` rather than Windows-style `CRLF`.
If you can, remove the end of line at the end of the file:
* VIm: `:set noeol` (optionally `:set nofixendofline`)
* perl: `perl -pi -e 'chomp if eof' $filename`
* shell: `printf %s "$(cat $filename)" > filename-without-nl.svg`
### Guidelines ### Guidelines
This is the standard guideline. Use this to help with sizing your icons and they will look good no matter what border radius is chosen. This is the standard guideline. Use this to help with sizing your icons and they will look good no matter what border radius is chosen.
@@ -41,8 +46,8 @@ This is the standard guideline. Use this to help with sizing your icons and they
Add a table cell to README.md - it must be in this format: Add a table cell to README.md - it must be in this format:
``` ```html
<td>Name of Service<br><img src="images/svg/nameofservice.svg" width="125" title="Name Of Service" /><br>123 Bytes</td> <td>Name of Service<br><img src="https://edent.github.io/SuperTinyIcons/images/svg/nameofservice.svg" width="125" title="Name Of Service"/><br>123 Bytes</td>
``` ```
Please add the correct file size. Please add the correct file size.
@@ -54,7 +59,7 @@ Please add the correct file size.
## Reference Page ## Reference Page
* Edit the file `/images/reference/index.md` * Edit the file [`images/reference/index.md`](images/reference/index.md)
* Add a link to the *official* style guide or brand guidelines. * Add a link to the *official* style guide or brand guidelines.
* For example `| <img src="/images/svg/nameofservice.svg" width="256" /> | <img src="/images/reference/nameofservice.jpg" width="256" /> | https://example.com/press |` * For example `| <img src="/images/svg/nameofservice.svg" width="256" /> | <img src="/images/reference/nameofservice.jpg" width="256" /> | https://example.com/press |`