Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
108 lines (69 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

108 lines (69 loc) · 2.45 KB
Raw

🤝 Contributing to Geo Sentinel AI

Thank you for your interest in contributing to Geo Sentinel AI.
Community contributions help improve the platform and accelerate development of new features.

🚀 Ways You Can Contribute

You can help the project in many ways:

  • 🐞 Report Bugs -- If you find an issue, open a GitHub Issue.
  • 💡 Suggest Features -- Share ideas that can improve Geo Sentinel.
  • 🧑‍💻 Submit Code -- Fix bugs or add new functionality.
  • 📖 Improve Documentation -- Help make guides clearer.
  • 🛰️ Develop New Modules -- Add integrations such as satellite tracking, OSINT feeds, or analysis tools.
  • 🔑 Provide API Keys or Data Sources -- Help integrate new public datasets, APIs, or intelligence feeds.

🔧 Getting Started

  1. Fork the repository
  2. Clone your fork
git clone https://github.com/YOUR_USERNAME/GeoSentinel.git
  1. Navigate to the project folder
cd GeoSentinel
  1. Create a new branch
git checkout -b feature-name
  1. Make your changes and commit
git commit -m "Add new feature"
  1. Push the branch
git push origin feature-name
  1. Open a Pull Request on GitHub.

🧠 Contribution Guidelines

  • Keep code clean and readable
  • Follow the existing project structure
  • Test features before submitting
  • Keep commits clear and descriptive
  • Respect open-source collaboration practices

🧪 Areas That Need Contributions

The following features are currently being improved:

  • 🔎 Facial Crime Search (In Development)
  • 📡 Real-time CCTV integrations
  • 🛰️ Satellite tracking improvements
  • 🚦 Traffic simulation enhancements
  • 📰 Live news data integrations

🔑 API Keys & Data Source Contributions

You can also help the project by sharing or helping integrate:

  • Public API endpoints
  • Open datasets
  • Satellite feeds
  • Traffic or CCTV sources
  • OSINT data providers

These integrations help expand the global monitoring capabilities of Geo Sentinel.

📬 Contact

If you would like to contribute data sources, APIs, or collaborate on development, please contact us:

🌐 https://haybnz.web.app/#section-contact

🌍 Community

Every contribution matters.
Together we can build a powerful open geospatial intelligence platform.

Thank you for supporting Geo Sentinel AI 🚀