[GH-ISSUE #1383] CONTRIBUTING.md #617

New issue

Open

opened 2026-03-03 14:39:46 +03:00 by kerem · 2 comments

kerem commented

2026-03-03 14:39:46 +03:00

Owner

Originally created by @p2made on GitHub (Jun 18, 2025).
Original GitHub issue: https://github.com/lipis/flag-icons/issues/1383

This replaces #1364, because I learned that I was effectively proposing a CONTRIBUTING.md file. This would help any who want to contribute know what is expected; what standards are required, what we should or should not do, & what flags may or may not be included. I hope that documenting expectations & requirements would make it easier for @lipis through, as examples, some being able to submit a quality PR instead of posting an issue, & some may be able to [say] see a flag request, attend to it, & submit a quality PR.

On what flags may or may not be included, I hope that many flags may be included, & few may not. I've said elsewhere that I'm big on representation, and flags are a means of representation. With that in mind...

@jagomf That was the whole idea.. but the pressure and we did some decisions to include them because of other reasons! That was the whole point.. we can include them all.. there are millions of flags :)

Originally posted by @lipis in #1183

And yes‼️ I hope we can include them all 🙃 I hope the scope of what flags can be included can be broad enough to allow for a wealth of representation.

The flags of interest to me for my own work are probably a couple of dozen. Adding logical extensions to those (completing the Federal subjects of Russia & Oblasts of Ukraine), & a couple of side quests, and I have well over 100 that I could contribute. I've actually done most of them, & I maintain an extension to flag-icons that makes them available to my work, but that doesn't make them available to others. Adding them to flag-icons would. I also have many of these is a few branches ready to submit as PRs.

Other considerations...

Optimisation: SVGs in flag-icins are optimised using svgo which makes a whole lot of sense. I've developed my own scripted workflow for that. Having the correct use documented would ensure consistency & should make less work for @lipis.

Size: I've concluded from looking at existing SVGs that it's 640x480 & 512x512 (I think I've seen a couple of exceptions). Having it explicitly specified would be helpful.

Curation: How should flags submitted in PRs be curated? Logical groupings or collections makes sense to me, although one person's idea of what makes a logical grouping might differ from another's. Also, some logical groupings might be large. There are 83 Federal subjects of Russia & almost 30 Oblasts of Ukraine.

Other work: Should someone submitting flags in a PR also update country.json & _variables.scss (was _flag-icons-list.scss) and recompile the CSS?

There's are probably more that I haven't thought of. I offer these thoughts in the spirit of wanting to be helpful to all.

Originally created by @p2made on GitHub (Jun 18, 2025). Original GitHub issue: https://github.com/lipis/flag-icons/issues/1383 This replaces #1364, because I learned that I was effectively proposing a [CONTRIBUTING.md](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors) file. This would help any who want to contribute know what is expected; what standards are required, what we should or should not do, & what flags may or may not be included. I hope that documenting expectations & requirements would make it easier for @lipis through, as examples, some being able to submit a quality PR instead of posting an issue, & some may be able to [say] see a flag request, attend to it, & submit a quality PR. On what flags may or may not be included, I hope that many flags may be included, & few may not. I've said elsewhere that I'm big on representation, and flags are a means of representation. With that in mind... > @jagomf That was the whole idea.. but the pressure and we did some decisions to include them because of other reasons! That was the whole point.. we *can* include them all.. there are millions of flags :) _Originally posted by @lipis in [#1183](https://github.com/lipis/flag-icons/issues/1183#issuecomment-2685581681)_ And yes‼️ I hope we can include them all 🙃 I hope the scope of what flags can be included can be broad enough to allow for a wealth of representation. The flags of interest to me for my own work are probably a couple of dozen. Adding logical extensions to those (completing the Federal subjects of Russia & Oblasts of Ukraine), & a couple of side quests, and I have well over 100 that I could contribute. I've actually done most of them, & I maintain an extension to `flag-icons` that makes them available to my work, but that doesn't make them available to others. Adding them to `flag-icons` would. I also have many of these is a few branches ready to submit as PRs. Other considerations... **Optimisation:** SVGs in `flag-icins` are optimised using `svgo` which makes a whole lot of sense. I've developed my own scripted workflow for that. Having the correct use documented would ensure consistency & should make less work for @lipis. **Size:** I've concluded from looking at existing SVGs that it's 640x480 & 512x512 (I think I've seen a couple of exceptions). Having it explicitly specified would be helpful. **Curation:** How should flags submitted in PRs be curated? Logical groupings or collections makes sense to me, although one person's idea of what makes a logical grouping might differ from another's. Also, some logical groupings might be large. There are 83 Federal subjects of Russia & almost 30 Oblasts of Ukraine. **Other work:** Should someone submitting flags in a PR also update `country.json` & `_variables.scss` (was `_flag-icons-list.scss`) and recompile the CSS? There's are probably more that I haven't thought of. I offer these thoughts in the spirit of wanting to be helpful to all.

kerem commented

2026-03-03 14:39:47 +03:00

Author

Owner

@p2made commented on GitHub (Jun 18, 2025):

My own contributions, & potential contributions, are...

#1371 - a small edit that means contributors using Mac (like myself) won't push .DS_Store files into flag-icons.
#1372 - responding to #1315.
#1374 - a core group of the many pride flags, contributed without prior consultation because it is Pride Month.
Flags for Aboriginal Australians (as 'au-aa') & the Torres Strait Islands (as 'au-tsi') - the first peoples of my country.
Flags of the States and territories of Australia - a couple of the offshore territories are already included, & it's my country.
#1375 (Wikipedia) as 'turkic' - in keeping with flags of other international organisations such as the United Nations & European Union.
#1376 flag (Wikipedia) as 'cis' - as above.
Flags of the Oblasts of Ukraine - some of which I use in my own work.
Flags of the Federal subjects of Russia - some of which I use in my own work.
The flag of Shetland - a subdivision of the United Kingdom with ISO 3166-2 of gb-zet & a personal interest.
The flags of other Turkic people & entities not otherwise represented - any of which I might use in my own work.
The flags of other Mongolic people & entities not otherwise represented - any of which I might use in my own work.

@p2made commented on GitHub (Jun 18, 2025): My own contributions, & potential contributions, are... * #1371 - a small edit that means contributors using Mac (like myself) won't push `.DS_Store` files into `flag-icons`. * #1372 - responding to #1315. * #1374 - a core group of the many pride flags, contributed without prior consultation because it is Pride Month. * Flags for [Aboriginal Australians](https://en.wikipedia.org/wiki/Aboriginal_Australians) (as 'au-aa') & the [Torres Strait Islands](https://en.wikipedia.org/wiki/Torres_Strait_Islands) (as 'au-tsi') - the first peoples of my country. * Flags of the [States and territories of Australia](https://en.wikipedia.org/wiki/States_and_territories_of_Australia) - a couple of the offshore territories are already included, & it's my country. * #1375 ([Wikipedia](https://en.wikipedia.org/wiki/Organization_of_Turkic_States)) as 'turkic' - in keeping with flags of other international organisations such as the United Nations & European Union. * #1376 flag ([Wikipedia](https://en.wikipedia.org/wiki/Commonwealth_of_Independent_States)) as 'cis' - as above. * Flags of the [Oblasts of Ukraine](https://en.wikipedia.org/wiki/Oblasts_of_Ukraine) - some of which I use in my own work. * Flags of the [Federal subjects of Russia](https://en.wikipedia.org/wiki/Federal_subjects_of_Russia) - some of which I use in my own work. * The flag of [Shetland](https://en.wikipedia.org/wiki/Shetland) - a subdivision of the United Kingdom with ISO 3166-2 of [gb-zet](https://en.wikipedia.org/wiki/ISO_3166-2:GB) & a personal interest. * The flags of other Turkic people & entities not otherwise represented - any of which I might use in my own work. * The flags of other Mongolic people & entities not otherwise represented - any of which I might use in my own work.

kerem commented

2026-03-03 14:39:47 +03:00

Author

Owner

@NotTsunami commented on GitHub (Sep 23, 2025):

https://github.com/lipis/flag-icons/pull/848/files

I did go to add this at one point, feel free to cherry-pick and modify if you'd like

@NotTsunami commented on GitHub (Sep 23, 2025): https://github.com/lipis/flag-icons/pull/848/files I did go to add this at one point, feel free to cherry-pick and modify if you'd like