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

Update contributing page

Browse Source
This commit is contained in:
Terence Eden
2024-09-09 16:16:20 +01:00
parent 9a48245aa3
commit 7780ac330e
2 changed files with 8 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@@ -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: Additionally, you can do these helpful things if you have time:
- [ ] Edit Readme - [ ] Edit Readme
- [ ] Add reference image - [ ] Add reference image
- [ ] Edit reference page - [ ] Add official brand guidelines URl
- [ ] Android Image - [ ] Android Image
## New File ## 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. * Find an *official* logo.
* Add it to `/images/reference/` * Add it to `/images/reference/`
* It must have the same filename as the image you added to `/images/svg/`
## Reference Page * 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/`
* Edit the file [`images/reference/index.md`](images/reference/index.md) * For example, create a file called `/images/reference/nameofservice.url` with the contents `https://example.com/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 |`
## (Optional) Create Android Version ## (Optional) Create Android Version

4
update_readme.py
View File

@@ -36,7 +36,7 @@ for ref_url in ref_list:
readme_table = "<table>\n" readme_table = "<table>\n"
check_table = '<table><tr><th>SVG Icon</th><th>Circle Icon</th><th>Reference</th><th>Source</th></tr>\n' check_table = '<table><tr><th>SVG Icon</th><th>Circle Icon</th><th>Reference</th><th>Source</th></tr>\n'
reference_table = "-|-|-\n" reference_table = "-|-|-\n"
missing_table = "&nbsp; | ** No Reference Image Found ** | &nbsp;\n" missing_table = "\n\n&nbsp; | ** No Reference Image Found ** | &nbsp;\n"
counter = 0 counter = 0
for svg in svg_data: for svg in svg_data:
@@ -58,7 +58,7 @@ for svg in svg_data:
reference_table += '\n' reference_table += '\n'
else: else:
missing_table += f'<img src="{img_domain}images/svg/{svg_file}" width="256" /> | {name} <br/>*[{svg}]* | \n' missing_table += f'<img src="{img_domain}images/svg/{svg_file}" width="256" /> | {name} <br/>*[{svg}.svg]* | \n'
check_table += '</tr>\n' check_table += '</tr>\n'