-
Notifications
You must be signed in to change notification settings - Fork 141
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/backwards-compatible changes or 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), and try to provide a good description of the changes made. 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.
During the alpha and beta development stages, versions are denoted with a prefix of v0 followed by 2 more digits. The second digit indicates a major feature or set of features, and the third digit indicates minor updates that are safe to merge with the existing feature set. For example, v0.3.4-alpha denotes the fourth minor update in the third set of features during the alpha development stage -- when the version reaches v0.4.0-alpha, this would imply a large feature was added and pulling this into your existing project may result in merge conflicts.
Once the project moves into beta development, the version number will still follow the same format, but with the -beta suffix. For example, v0.6.1-beta is a valid version.
Once the project is officially released, the version will be denoted with v1 as the prefix. For example, v1.0.0 will be the first official release of the project. Versioning methodology will be re-evaluated at that point.