-
Notifications
You must be signed in to change notification settings - Fork 144
Contributing
Pull requests for features are welcome. Please open an issue first to discuss the feature you would like to add, or the bug you would like to fix. Alternatively, you may join the official Discord server and discuss the project there.
The project has been developed in a Git Flow style during Alpha development. This means that the main branch is the stable branch, and the development branch is where new features are staged. The development branch is where all pull requests should be made to unless they are minor changes / urgent bug fixes. Most PRs should be based on the main branch unless they build on features staged for a later release. Please ensure that PRs are made for a single feature at a time (i.e., PRs that include a wide variety of unrelated changes will be rejected). In later iterations, we will move towards trunk-based CI/CD.
OSBC uses Flake8 for code style, and follows Google-style docstrings. We also use Black for code formatting. Please run the pre-commit run --all-files command locally before committing your changes to ensure that your code is formatted correctly.