search

finnbear / rustrict

rustrict is a profanity filter for Rust
https://crates.io/crates/rustrict
MIT License
92 stars 10 forks source link

Documentation: Extending the word list #10

Open mkadirtan opened 1 year ago

mkadirtan commented 1 year ago

It would be great if this project had documentation for extending the word lists. Especially if non-developers can contribute here, this library can evolve into a complete solution for profanity filtering.

If you can add the documentation, I can contribute to it for the Turkish language and hopefully get my company to contribute for Russian, Ukranian, and Indonesian, too!

finnbear commented 1 year ago

I appreciate and agree with the suggestion!

For now, please suggest word list changes using GitHub issues (there is an issue template for this). In the past, processing issues has been an efficient way to get words added while there would be some gotchas with PR's.

Before anyone tries to contribute directly, I want to organize wordlists and tests a bit better (in particular, I want to move away from using CSV to store profanities).

mkadirtan commented 1 year ago

Is there anything I or others can help with?