Skip to content

CONTRIBUTING.md #1383

@p2made

Description

@p2made

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions