Contributing ============ Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given. Code Formatting ---------------- We use `AutoPEP8`_ for code formatting and standardization. Check out the `pyproject.toml`_ file at root directory. Report Bugs ----------- Report bugs through `Github issue`_. Please report all relevant information and preferably code that exhibits the problem. Do not try to email us about the issues, we will not respond to any emails, submit a proper Github issue instead. Fix Bugs -------- Look through the `Github issue`_ for bugs. Anything is open to whoever wants to implement it. Implement Features ------------------ Look through the `Github issue`_ or `Malaya-project`_ for feature requests. Any unassigned ``improvement`` issue is open to whoever wants to implement it. We use Pytorch and heavily use HuggingFace Transformers as backend. Dataset Contributions --------------------- Create a new issue in `Github issue`_ that's related to your data including the data link or just attach it there. If you want to improve the current dataset we have, you can check at `Malaya-Dataset`_. Alternatively, you can simply email your data if you do not want to expose the data to the public. Malaya will not expose your data, but our trained models that's based on your data will be exposed to the public. Thanks to, 1. `Fake news`_, contributed by `syazanihussin`_ 2. `Speech voice`_, contributed by `Khalil Nooh`_ 3. `Speech voice`_, contributed by `Mas Aisyah Ahmad`_ 4. `Singlish text dump`_, contributed by `brytjy`_ 5. `Singapore news`_, contributed by `brytjy`_ Documentation Improvements -------------------------- Malaya could always use better documentation, there might be some typos or incorrect object names. Submit Feedback --------------- The best way to send feedback is to open an issue through `Github issue`_. Unit Test --------- Help test every step of the program flow! You can check the current available `unit tests here`_. Feel free to help Malaya write unit-tests, fork the repository! .. _Types of Contributions: #types-of-contributions .. _Report Bugs: #report-bugs .. _Fix Bugs: #fix-bugs .. _Implement Features: #implement-features .. _Dataset: #dataset .. _Improve Documentation: #improve-documentation .. _Submit Feedback: #submit-feedback .. _Documentation: #documentation .. _Local development environment: #local-development-environment .. _Installation: #installation .. _Pull Request Guidelines: #pull-request-guidelines .. _Github issue: https://github.com/mesolitica/Malaya/issues/new .. _Malaya-project: https://github.com/mesolitica/Malaya/projects/1 .. _Malaya-Dataset: https://github.com/mesolitica/Malaya-Dataset .. _Fake news: https://github.com/mesolitica/Malaya-Dataset#fake-news .. _syazanihussin: https://github.com/syazanihussin/FLUX/tree/master/data .. _Speech voice: https://github.com/mesolitica/Malaya-Dataset#tolong-sebut .. _Khalil Nooh: https://www.linkedin.com/in/khalilnooh/ .. _Mas Aisyah Ahmad: https://www.linkedin.com/in/mas-aisyah-ahmad-b46508a9/ .. _Singlish text dump: https://github.com/mesolitica/malaya-dataset#singlish-text .. _brytjy: https://github.com/brytjy .. _Singapore news: https://github.com/mesolitica/malaya-dataset#singapore-news .. _unit tests here: https://github.com/mesolitica/Malaya/tree/master/tests .. _AutoPEP8: https://github.com/hhatto/autopep8 .. _pyproject.toml: https://github.com/mesolitica/malaya/blob/master/pyproject.toml