diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cb59da60..c99fe90b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,14 +9,14 @@ Thanks for submitting or fixing an icon! Here is a helpful guide to what you nee ## New File 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/` At a minimum, your icon needs these components: -``` -... 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 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: -``` -Name of Service

123 Bytes +```html +Name of Service

123 Bytes ``` Please add the correct file size. @@ -54,7 +59,7 @@ Please add the correct file size. ## 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. * For example `| | | https://example.com/press |`