Thank you for taking interest in contributing to the sentimental analysis bot.
The following are guidelines for contributing to the project.
License is GNU General Public License v3.0.
By contributing to the project you agree to abide by it.
- Clone the repository and make sure it runs with
python3 main.py(may require creating a .env file with valid token). - Branch out from
master. - Please keep commits small and passing existing tests.
- Any new kernels created should extend the class
kernels.kernel.AbstractKernel. - Create applicable tests for new methods as needed. All non-bot methods (so anything outside of
main.py) should be tested. Discord bot related commands are difficult to test hence are not mandatory to be unit tested but should be tested manually by code-author. - Create a pull request citing issue that is fixed. All code must be up to date with the
masterbranch at the time of submitting the request. - All requests should address a given issue on the tracker. If one does not (for example adding a new kernel that is not specified), then create a new issue and submit a PR citing it.
Keep all commits and conversation civil and sans any explicit language.
For any queries or if stuck with anything, contact Nikolai#4151 in the CSCH Discord.