Skip to content
This repository was archived by the owner on Jun 3, 2024. It is now read-only.

Contributing

Kellen Evoy edited this page Jan 3, 2023 · 12 revisions

Contributing to OSRS-Bot-COLOR

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.

Open an Issue

Join the Discord Server

Git Branching Model

During Alpha development, the project has been developed in a Git Flow style. This means that the master branch is the stable branch, and the develop branch is where all new features are merged into. The develop branch is also where all pull requests should be made to unless they are minor changes / urgent bug fixes. In later iterations, we will move towards CI/CD.

Code Style

OSBC uses Flake8 for code style, and loosely 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.

Clone this wiki locally