Skip to content

Latest commit

 

History

History
60 lines (53 loc) · 4.56 KB

CONTRIBUTING.md

File metadata and controls

60 lines (53 loc) · 4.56 KB
Raw

You want to contribute to Lingua? That's great!

In case you want to contribute something to Lingua, then I encourage you to do so. Do you have ideas for improving the API? Are there some specific languages that you want to have supported early? Or have you found any bugs so far? Feel free to open an issue or send a pull request. It's very much appreciated.

For pull requests, please make sure that all unit tests pass and that the code is formatted according to the official Rust style guide with cargo fmt.

All kinds of pull requests are welcome. The pull requests I favor the most are new language additions. If you want to contribute new languages to Lingua, here comes a detailed manual explaining how to accomplish that.

Thank you very much in advance for all contributions, however small they may be.

How to add new languages?

  1. Clone Lingua's repository to your own computer as described in README's section 8.
  2. Open enums IsoCode639_1 and IsoCode639_3 and add the language's iso codes. Among other sites, Wikipedia provides a comprehensive list.
  3. Open enum Language and add a new entry for your language. If the language is written with a script that is not yet supported by Lingua's Alphabet enum, then add a new entry for it there as well.
  4. If your language's script contains characters that are completely unique to it, then add them to the respective method in the Language enum. However, if the characters occur in more than one language but not in all languages, then add them to the CHARS_TO_LANGUAGES_MAPPING constant instead.
  5. Use LanguageModelFilesWriter to create the language model files. The training data file used for ngram probability estimation is not required to have a specific format other than to be a valid txt file with UTF-8 encoding. Do not rename the language model files.
  6. Use TestDataFilesWriter to create the test data files used for accuracy report generation. The input file from which to create the test data should have each sentence on a separate line. Do not rename the test data files.
  7. Create a new crate in /language-models. Add a subdirectory named after the new language's ISO 639-1 code and put the crate's content in there, including the language model files and the test data files. Look at the other languages' crates to see how it looks like. It should be pretty self-explanatory.
  8. Add the new crate as a dependency to the main Cargo.toml.
  9. Add the new language to the functions in /src/models/mod.rs and /examples/accuracy_reports.rs so that Lingua can find the language model and test data directories.
  10. Fix the existing unit tests by adding your new language.
  11. For accuracy report generation, run cargo run --release --example accuracy_reports.
  12. Be happy! :-) You have successfully contributed a new language and have thereby significantly widened this library's fields of application.