milesj / emojibase

🎮 A collection of lightweight, up-to-date, pre-generated, specification compliant, localized emoji JSON datasets, regex patterns, and more.
https://emojibase.dev
MIT License
465 stars 38 forks source link

Supported locale questions #108

Open roderickhsiao opened 3 years ago

roderickhsiao commented 3 years ago

Thanks for the library!

This is the current supported locale https://emojibase.dev/docs/datasets/#supported-locales

But from https://github.com/unicode-org/cldr-json it seems like there are much more supported emoji locale from the github json repository.

Wondering what are the main differences between http://unicode.org/Public/emoji/ and the github repo one

milesj commented 3 years ago

@roderickhsiao So emojibase only supports locales that have been requested by the community. Felt like overkill to support all of them from the beginning.

roderickhsiao commented 3 years ago

Thanks! the reason we are checking is that we are trying to utilize the data from emoji-button https://github.com/joeattardi/emoji-button/commit/dbf36babe0bb01332526100429306700b906547b#commitcomment-51733591

which we currently have the full list from CLDR repo. But agree that it might be overkill to support all at the beginning

ahukkanen commented 1 year ago

So emojibase only supports locales that have been requested by the community. Felt like overkill to support all of them from the beginning.

@milesj Could you add some details about the criteria and process on how to suggest a new locale? It would be useful if this information was available on the mentioned page where I think it would be easy to find: https://emojibase.dev/docs/datasets/#supported-locales

Should we create a new GitHub issue to suggest a new locale? And do you have some other criteria, e.g. accumulating a certain amount of thumbs up / support for the issue?

milesj commented 1 year ago

@ahukkanen No real guide here, but feel free to create a new issue for it and we can discuss there.

ahukkanen commented 1 year ago

@milesj We are using a library that loads the emoji data using emojibase in Decidim. Here is the status for all translations of that software: https://translate.decidim.org/

From that list, taking all the locales that are >= 70% translated and not currently supported by emojibase, I would suggest the following languages to be added to this library:

milesj commented 1 year ago

@ahukkanen Adding support for these is quite time consuming and I don't have time right now. However, I can write a quick doc on how to do it if you feel like contributing a PR for each lang?

ahukkanen commented 1 year ago

@milesj That would help a lot. We can probably get someone from the maintainers team to handle at least some of those PRs, depends how big of an effort it would be.

milesj commented 1 year ago

@ahukkanen Here you are: https://github.com/milesj/emojibase/blob/master/docs/add-new-language.md

The steps are pretty simple. Most of the work is with translations.

ahukkanen commented 1 year ago

Thank you very much @milesj !

Could you clarify also how to enable the locale? Should this be done in the same PR? E.g. I see that you added the Catalan files at #158 but the language is not listed at SUPPORTED_LOCALES: https://github.com/milesj/emojibase/blob/48f6fcd514a3f4c4ebe4fd2f6503bd6f3cc3db2f/packages/core/src/constants.ts#L87

Do we add the new locale to that list in the same PR or who takes care of that?


Ping @andreslucena, see the above link for PR instructions. Maybe we can start with Catalan and see how big of an effort it would be (?).

It involves also translating some labels and group names but for Catalan (ca), it seems the base files were were already added in the PR that created the docs (#158). So we'll need to review those and create a PR to enable it.

Maybe we could also find a collaborative way to crowdsource the rest of the languages from people from the community who can speak those. Any ideas?

milesj commented 1 year ago

@ahukkanen Whoops, accidentally committed ca. I removed them off master.

All the changes in that doc should be done in 1 PR.