From 7780ac330e5547c2ee212a70cfc3822319089317 Mon Sep 17 00:00:00 2001 From: Terence Eden Date: Mon, 9 Sep 2024 16:16:20 +0100 Subject: [PATCH] Update contributing page --- CONTRIBUTING.md | 14 ++++++-------- update_readme.py | 4 ++-- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2cb75f8f..a549b66e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Thanks for submitting or fixing an icon! Here is a helpful guide to what you nee Additionally, you can do these helpful things if you have time: - [ ] Edit Readme - [ ] Add reference image -- [ ] Edit reference page +- [ ] Add official brand guidelines URl - [ ] Android Image ## New File @@ -59,12 +59,10 @@ This will update the average file size at the top of the file as well as regener * Find an *official* logo. * Add it to `/images/reference/` - -## Reference Page - -* 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 |` +* It must have the same filename as the image you added to `/images/svg/` + * It's OK if it has a different extension. `nameofservice.png` is fine. +* Add the brand guidelines URl in a new file within `/images/svg/` + * For example, create a file called `/images/reference/nameofservice.url` with the contents `https://example.com/brand-guidelines` ## (Optional) Create Android Version @@ -76,4 +74,4 @@ See: https://issuetracker.google.com/issues/176694227 Or, use https://inloop.github.io/svg2android/ to create an Android-compatible XML file. -Add the file to `/images/android-vector-drawable/` +Add the file to `/images/android-vector-drawable/` \ No newline at end of file diff --git a/update_readme.py b/update_readme.py index ce78d508..c963eb8f 100644 --- a/update_readme.py +++ b/update_readme.py @@ -36,7 +36,7 @@ for ref_url in ref_list: readme_table = "\n" check_table = '
\n' reference_table = "-|-|-\n" -missing_table = "  | ** No Reference Image Found ** |  \n" +missing_table = "\n\n  | ** No Reference Image Found ** |  \n" counter = 0 for svg in svg_data: @@ -58,7 +58,7 @@ for svg in svg_data: reference_table += '\n' else: - missing_table += f' | {name}
*[{svg}]* | \n' + missing_table += f' | {name}
*[{svg}.svg]* | \n' check_table += '\n'
SVG IconCircle IconReferenceSource