Thank you for considering to contribute to aiosu!
This document is here to help you get started by showing you the expectations for contributions and make it more accesible to everyone. You are still free to open unfinished PRs and ask questions though!
In case you'd like to ask questions, you can contact me on Discord.
aiosu uses black formatting. It is recommended that you use the provided pre-commit hook to aid you in maintaining proper styling.
Imports that are only used for typing must be put in an if TYPE_CHECKING statement. They also must be the last imports in the file.
aiosu uses poetry for publishing and managing environments. You may use the provided dev group.
aiosu uses Sphinx formatting for docstrings. You should also familiarize yourself with reStructuredText.
aiosu uses semantic versioning. Version numbers are formatted as follows: MAJOR.MINOR.PATCH.
In order to publish a release, you may use the provided Makefile.
Publish without bumping version number
$ make release
$ make release ver=<args>Valid arguments for release versions can be found here