Thank you for your interest in contributing!
Please take a moment to review this document to ensure a smooth and effective contribution process for everyone involved. Following these guidelines shows respect for the developers managing this open-source project, and in return, we promise to reciprocate that respect in addressing your contributions.
If you have questions or would like to connect with the team, please join us in our public chat rooms. We’re excited to hear from you!
First steps as a contributor ⇧
Thank you for your interest in contributing to Bunk Mate! We look forward to welcoming you to our community. Here are some suggested steps for getting started:
- Join our public chat to connect with the community.
- Read through this contributing guide for all the information you need.
- Look for issues marked
good first issueto understand what you can work on.
Note
Those new to Flutter or wanting to improve their skills are welcome to contribute! The team is happy to help you on your development journey.
Learning the tech stack ⇧
Bunk Mate is built using Flutter, which allows for cross-platform development. Here are some resources to help you get started:
Development environment ⇧
To set up your development environment for Bunk Mate, follow these steps:
- Install Flutter on your machine.
- Clone the Bunk Mate repository:
git clone https://github.com/Bunk-Mate/Mobile-App.git
cd Mobile-App- Run the app locally using:
flutter run- Ensure you have an emulator or physical device set up to see the app in action.
Note
Feel free to reach out in our chat if you encounter any issues during setup!
Issues and projects ⇧
The issue tracker for Bunk Mate is the preferred channel for bug reports, feature requests, and pull requests. You can also explore related issues organized into projects.
Note
If an issue is assigned, it doesn’t mean we aren’t interested in your contribution. Feel free to discuss it with us in the issues!
Bug reports ⇧
A bug is a demonstrable problem caused by the code in the repository. Good bug reports are invaluable. Here’s how to create a great bug report:
- Search the issue tracker to check if the bug has already been reported.
- Try to reproduce the issue using the latest version of the app.
- Provide clear details in your report:
- A summary
- Steps to reproduce
- Expected behavior
- Actual behavior
- Any additional notes (e.g., what you tried that didn’t work)
Use the bug report template when submitting your report.
Feature requests ⇧
Feature requests are welcome! When submitting a feature idea, please provide as much context as possible, and indicate how you would like to contribute to its development. Use the feature request template.
Pull requests ⇧
Pull requests are essential for our community. Please ensure that your pull request focuses on a specific issue or feature and does not include unrelated changes. Here’s how to submit a pull request:
- Get the latest changes from the main branch:
git checkout main
git pull upstream main- Create a new branch for your feature or fix:
git checkout -b feature-branch- Commit your changes with clear messages following Conventional Commits.
- Push your branch to your fork:
git push origin feature-branch- Open a Pull Request with a clear title and description.
Thank you for your contributions!
Data edits ⇧
For updates to attendance data or class schedules, please discuss potential changes with the team. We can help integrate necessary adjustments.
Documentation ⇧
Documentation is vital for helping others understand the project. If you notice areas that need improvement, feel free to submit an issue marked with the documentation label.
Thank you for being a part of the Bunk Mate community! We look forward to collaborating with you.