How to Contribute
We're thrilled you're interested in contributing to BLACK! As an open-source project, we thrive on community support. Your contributions help us build a better tool for students everywhere.
Types of Contributions
We welcome various forms of contributions, including but not limited to:
- → Reporting bugs and suggesting features in the GitHub Issues.
- → Writing or improving documentation.
- → Submitting pull requests with bug fixes or new features.
- → Helping answer questions in the community forums.
Getting Started
To get started, please visit our repository on GitHub. The main branch contains the most up-to-date code. Fork the repository and create a new branch for your changes.
Development Setup
The application is built using Flutter for the cross-platform framework and Firebase for the backend. You will need to have the Flutter SDK installed on your machine. A `firebase_options.dart` file with your own Firebase project credentials will be required to run the app locally.
Pull Request Process
- Ensure any installation or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.