TypeFast
TypeFast copied to clipboard
Guidelines for contributing new languages
Problem
I'd was thinking about contributing a new language, but there were no instructions for that.
Suggestion
Maybe the readme should have instructions. Or, put it in a contributing.md along with the rest of the contributing guidelines.
Other
Questions to consider:
- are you looking for new languages
- how many words/sentences per language
- around how many characters for each word/sentence
- how to choose words/sentences (eg. how common are they, how easy are they to type)
Some written down gudielines would indeed be a good idea, until I do that you can follow this pull request as an example: https://github.com/CasperVerswijvelt/TypeFast/pull/7.
Quick answers for your questions:
- are you looking for new languages Yes, the more the better (but don't just add languages for the sake of it, only when someone would actually like to use it)
- how many words/sentences per language I mostly just selected what I could find online by just googling 'x most common words in language'. I think the max amount of words I have for a single language is about 5k now. For languages I don't really have a target number. My main worry is that the files will become too big in size which means the language loading will take longer. English sentences is about 1.2 MB now and that still seems to load fine for me, but that is already too big for my liking.
- around how many characters for each word/sentence This is probably very language dependent, so it's not really something i took into account. For words i just take the 'x most common words' that I can find, and for sentences I take what I can find online from quotes lists or whatever
- how to choose words/sentences (eg. how common are they, how easy are they to type) Words should be common, I don't take into account how easy they are to type. I don't want to have a test with only easy to type words, since the test would no longer be a realistic situation.
Hope that answers your questions until I can make some contributing guidelines. Look forward to seeing your language addition :)