How To Contribute

Thank you for helping OpenFloodAI.

This project is about flood warning support, so clear and careful work matters more than fast or flashy work.

Start Here

1. Read the V1 Requirements.
2. Read the Community Feedback page for public ideas and research questions.
3. Read the Privacy And Retention page before using local data.
4. Check the GitHub repository.
5. Pick a small issue.
6. Keep changes focused.
7. Add tests when behavior changes.

Local Setup And Checks

See the Developer Quickstart for cloning the repository, setting up a virtual environment, and running the full check suite before opening a pull request.

Contribution Rules

• Do not commit private videos, camera URLs, passwords, GPS coordinates, or personal contact details.
• Do not add public warning behavior without a focused design and review.
• Do not claim real flood detection accuracy without field evidence.
• Keep examples simple and safe.
• Use plain language in docs.

Simple example: a pull request that adds a test helper should explain what it tests and what it does not test.

Community

• Community Feedback
• GitHub repository
• Discord discussion