how to contribute

[palight]

Hi, i saw folders for english and italian in src. Is it the only place to add new language ?

Thanks

[Stypox]

I will update the README tomorrow with information about how to contribute. Thank you for opening the issue and reminding me this needs to be done ;-)

[Stypox]

@palight I added part of the explanation (currently only focusing on resources). It's still not finished, since I need to give a better documentation to how Java classes are "translated", but at least it's a start. What do you think about it?

[AlanSanchezP]

Hi, I started working on the spanish translation following the guide you wrote, but I'm not sure how to run the tests described by date_time_test.json.

[Stypox]

I still need to explain how to write the Java code. The tests for date&time formatting are these for the English language, and that class inherits DateTimeTestBase which runs the tests in date_time_test.json

[sl1txdvd]

I started to work on German and did what is in the Readme file. However I don't know what Java files to touch and what do there exactly. I will take a look at the other languages, but some more info would be appreciated.

Especially how I can test to see if what I am doing is working would be good to know.

[Stypox]

The language-dependent java files are those found in the org.dicio.numbers.lang.LANGUAGE_CODE modules. In order to test your changes you need to create test files (also, it is strongly advised to create those, otherwise it's almost impossible to make sure that such specific code does its job).

For example, this is the structure of the English java files. Green files are for tests. The only really required files are actually just EnglishParser and EnglishFormatter, which extend Parser and Formatter respectively, but I suggest you to roughly keep the structure of other files, too, in order to keep things separated.

[tiptoptom]

I started to work on German and did what is in the Readme file. However I don't know what Java files to touch and what do there exactly. I will take a look at the other languages, but some more info would be appreciated.

Especially how I can test to see if what I am doing is working would be good to know.

What is the status of the German translation? Does it need support?

[Fadikkop]

I’m also interested in german translation and would like to help

[Stypox]

I have put very little attention on this repo until now, I am very sorry about this :-/

I did so since I made changes to the interface a few times and I had plans to change it again to make it even more flexible (basically using the code in Dicio's skill input matching implementation), but in the end I likely won't do anything like that as it would be too complicated and give few benefits.

I will now try to go through the various PRs, and write some documentation on how to make translations.

Please note that the important part is translating the parser (written in Kotlin). Translating just the .word and .json files will only make parts of the formatter work, but parsing numbers is the thing that makes this library useful. LLMs can likely help out with translating Kotlin files though, see the progress in #12 (however code still needs to be heavily reviewed).

@tiptoptom @Fadikkop also see my response about German in #7