Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.42 KB
Raw

contributing to safetext 🚀

we're thrilled to have you contribute to safetext! your efforts help enhance a powerful tool for content moderation.

how can I contribute? 🤝

adding new languages 🌐

  1. create a folder: make a new folder in the languages directory with the ISO 639-1 code of the language (e.g., fr for French).
  2. add words.txt: in this folder, add a words.txt file containing a list of profanity words/phrases, one per line.

enhancing existing lists 🔍

  • improve a language's words.txt by adding new words or refining the list by removing false positives.

bug reports & suggestions 🐛

  • use the discussions section for bug reports, feature requests and any questions.
  • share your feedback or suggestions to help us improve.

pull request process 📝

  1. fork the repo: click 'Fork' on GitHub to copy the repository.
  2. create a branch: make a branch in your fork, e.g., add-spanish.
  3. make changes: update or add files.
  4. commit: commit your changes with a clear message.
  5. push: upload your changes to your Github fork.
  6. open a PR: go to the original safetext repository, click 'New Pull Request', pick your branch, then submit it with a clear description of your changes.

license

Contributions are under the MIT License.