First, thank you for considering contributing to Hourai! It's people like you that make the open source community such a great community! 😊
We welcome any type of contribution, not only code. You can help with
- QA: file bug reports, the more details you can give the better (e.g. screenshots of the bot's behavior)
- Marketing: writing howto's, voting for the bot on top.gg, ...
- Translation: Translating documentation, bot messages, etc. to other languages.
- Documentaion: Hourai is a complicated bot, improving documentation and giving feedback on how the docs are written helps everyone understand and use it.
- Networking: Expanding Hourai's footprint on Discord, sharing and adding the bot with others.
- Code: take a look at the open issues. Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.
Hourai is a large, complicated project that may be difficult to fully grasp for many contributors. If you have any questions, please join the support Discord server or refer to any of the following documentation links for more infomation.
Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.
The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?
Please be mindful of the others contributing to the project. Those in violation of the Code of Conduct will be dealt with appropriately.