From 5e461321ef46e0cb98ae0bde52a8c57edf4f1ee9 Mon Sep 17 00:00:00 2001 From: Terence Eden Date: Mon, 12 Feb 2018 11:59:30 +0000 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..237e0b97 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +Thanks for sumbitting or fixing an icon! Here is a helpful guide to what you need to include. + +- [ ] New file +- [ ] Edit Readme +- [ ] Edit radius page +- [ ] Add reference image +- [ ] Edit refernce page +- [ ] (optional) Android Image + +## New File + +Filename should be `nameofservice.svg` - all in lower-case. + +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. + +## Edit Readme + +Add a table cell to README.md - it must be in this format: + +``` +
229 Bytes +``` + +## Edit Radius Page + +* Edit the file `radius.html` +* Add the name of your service to `var items` +* For example `, 'nameofservice', ` + +## Reference Image + +* Find an *official* logo. +* Add it to `/images/reference/` + +## Reference Page + +* Edit the file `/images/reference/index.md` +* Add a link to the *official* style guide or brand guidelines. +* For example `| | | https://example.com/press |` + +## (Optional) Create Android Version + +* Use https://inloop.github.io/svg2android/ to create an Android-compatible XML file. +* Add the file to `/images/android-vector-drawable/`