Thanks for being interested in contributing to the Brawl Box project! There are two different ways of contributing, which are explained in further detail below.
Details about the tech stack, instructions for environment setup and configuration keys can be found in the README file.
There is a #development channel in the support server at https://discord.gg/bXQaeFM dedicated to communication about the development process. For more information about contributing to Brawl Box, check in over there.
While the feature set of Brawl Box is fairly complete, there are still ways improve the experience. For example, a command interface could be made more intuitive and user-friendly. Or, a background process that's responsible for fetching the required data could be optimised significantly.
The code in this version of Brawl Box is mainly designed and implemented by Robin Mahieu, nicknamed Papier. This causes a very opinionated approach throughout the source code, which may not always be the best one. A fresh look on things is always welcome!
Upon discovering a bug, please create an issue. This way, a core maintainer can confirm the problem and swiftly implement a fix. Alternatively, feel free to submit a pull request with a short description of the bug and your proposed solution.
Please try to include
- the version number of Python, Brawl Box and dependency packages;
- the type and version of the operating system;
- instructions to reproduce the issue.
The Brawl Box project adheres to the PEP 8 code style guidelines, utilising black and flake8 to enforce this. In particular, the usage of double quotes and a maximum line length of 79 characters is required.
Furthermore, the usage of full sentences and British English is preferred where applicable.