Thank you for your interest in contributing! This document provides guidelines and instructions for contributing to this project.
-
Fork the repository on GitHub
-
Clone your fork locally:
git clone https://github.com/litemars/BeaconDetectionSystem.git cd BeaconDetectionSystem -
Set up the development environment:
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate pip install -r requirements.txt pip install -r requirements-dev.txt
-
Create a feature branch:
git checkout -b feature/your-feature-name
-
Make your changes and commit them with clear messages:
git commit -m "Add: brief description of changes" -
Run tests and linting:
pytest black --check control_plane data_plane
-
Push to your fork:
git push origin feature/your-feature-name
-
Create a Pull Request with a clear description of your changes