Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (62 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

88 lines (62 loc) · 2.19 KB

🚗 Contributing to MooVit

Thanks for your interest in contributing to MooVit! 🚀
We’re building an AI-powered real-time object detection and voice-assist system to:

  • Improve road safety
  • Assist visually impaired users
  • Optimize logistics operations

📌 How to Contribute

1️⃣ Fork & Clone the Repository

Fork the repository and clone it locally:

git clone https://github.com/your-username/moovit.git
cd moovit

2️⃣ Create a New Branch

Use a clear and descriptive branch name:

git checkout -b feature/your-feature-name

3️⃣ Make Your Changes

You can help by:

  • 💻 Adding new detection features or AI models
  • 🐞 Fixing bugs or improving performance
  • 🧪 Enhancing shipment scheduling and route safety modules
  • 🎨 Improving UI/UX for accessibility and ease of use
  • 🌐 Adding localization or multilingual voice support
  • 📄 Improving documentation

Ensure your changes align with MooVit's goals and are clean, tested, and documented.

4️⃣ Test Before You Commit

  • Run your backend (app.py) and frontend locally to ensure everything works
  • Test detection accuracy and voice alerts
  • Validate that shipment scheduling and routing modules behave as expected
  • Add/update test cases if applicable

5️⃣ Commit and Push

Write clear, descriptive commit messages:

git add .
git commit -m "feat: short description of your change"
git push origin feature/your-feature-name

6️⃣ Submit a Pull Request (PR)

  1. Go to your fork on GitHub
  2. Click Compare & Pull Request
  3. Clearly describe your changes and link related issues (if any)
  4. Include before/after screenshots or demo GIFs if relevant

✅ Contribution Checklist

  • My code follows the project style and conventions
  • I’ve tested my changes locally
  • I’ve updated relevant documentation
  • I’ve linked related issues/PRs if applicable
  • I’ve added comments for complex logic

💬 Need Help?

If you have questions or suggestions:

  • Open an issue
  • Tag a maintainer in the discussion