how to contribute

Question

how to contribute

palight opened this issue 2 years ago · comments

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

Thanks

Stypox · Answer 1 · Tue May 03 2022 04:29:40 GMT+0800 (China Standard Time)

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 · Answer 2 · Tue May 03 2022 20:54:09 GMT+0800 (China Standard Time)

@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?

Alan Sánchez Pineda · Answer 3 · Mon May 09 2022 08:12:06 GMT+0800 (China Standard Time)

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 · Answer 4 · Mon May 09 2022 17:41:02 GMT+0800 (China Standard Time)

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

rauschen · Answer 5 · Wed Feb 01 2023 02:56:26 GMT+0800 (China Standard Time)

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 · Answer 6 · Mon Feb 06 2023 04:51:08 GMT+0800 (China Standard Time)

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.