Thank you for your interest in contributing to SafeVision!
Your contributions will help us create a safer world through AI-driven real-time surveillance.
This project is part of the IEEE Summer of Projects (SoC) and is currently in an early development phase.
We are actively looking for contributors to help expand and improve the system.
We welcome contributions in the following areas:
- 🧠 Integrating new AI models for body language, facial expression, and crowd behavior analysis.
- 🎯 Improving crime detection accuracy and risk evaluation algorithms.
- 🖥️ Building a more interactive user interface.
- 🛠️ Writing unit tests and improving code quality.
- 🐳 Dockerizing the app for easier deployment.
- 📜 Improving documentation and tutorials.
Follow these steps to get started:
- Fork the repository.
- Clone your fork locally.
- Set up a virtual environment (recommended).
- Install dependencies:
pip install flask opencv-python ultralytics
- Run the app:
python app.py
-
Open an Issue
- Before starting any major work, please open an issue to discuss your idea.
- Look for issues labeled "Good First Issue" or "Help Wanted".
-
Fork the Repository
-
Create a Feature Branch
git checkout -b feature/your-feature-name
-
Make Your Changes
-
Test Your Changes
-
Commit Your Changes
git commit -m "Add: your meaningful commit message" -
Push to Your Fork
git push origin feature/your-feature-name
-
Open a Pull Request
- Follow the pull request template provided.
- Describe the changes you made and reference related issues.
- Follow clean and readable Python coding practices.
- Use meaningful commit messages.
- Comment your code where necessary.
- Write modular and reusable code.
Please read our Code of Conduct to ensure a welcoming and respectful environment for everyone.
Check the Issues page!
Look for issues labeled:
- good first issue
- help wanted
Thank you for helping us make SafeVision better! 💬
We are excited to collaborate with you! 🚀