diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 0000000..f70521b --- /dev/null +++ b/CONTRIBUTION.md @@ -0,0 +1,73 @@ +# Contributing to ESP32-CAM-ONVIF + +Thank you for your interest in contributing to **ESP32-CAM-ONVIF**! +Your help is essential to make this project robust, feature-rich, and easy to use for everyone. +We welcome contributions of all kinds: code, documentation, bug reports, feature requests, and ideas. + +--- + +## How to Contribute + +### 1. Fork & Clone + +- Fork the repository to your own GitHub account. +- Clone your fork: + +- Open a Pull Request (PR) against the `main` branch of this repository. +- In your PR description, include: +- A summary of your changes +- Any relevant issue numbers (e.g., `Closes #123`) +- Screenshots or logs if applicable + +### 6. Respond to Feedback + +- Be ready to answer questions or make revisions. +- We may suggest changes or request further testing. + +--- + +## What Can You Contribute? + +- **Features**: Add new capabilities (e.g., web UI, SD recording, motion detection) +- **Bug Fixes**: Find and squash bugs +- **Documentation**: Improve guides, add examples, or clarify instructions +- **Testing**: Test on different hardware/NVRs and report results +- **Ideas**: Suggest improvements or new directions + +--- + +## Guidelines + +- **Follow best practices**: Comment your code and keep it readable. +- **Respect the project structure**: Organize new files logically. +- **Document new features**: Update README.md and add usage notes. +- **Stay compatible**: Ensure your changes work with both PlatformIO and Arduino IDE. +- **Be respectful**: All interactions should be friendly and constructive. + +--- + +## Reporting Issues & Feature Requests + +- Use [GitHub Issues](https://github.com/John-Varghese-EH/ESP32-CAM-ONVIF/issues) for: +- Bug reports (include logs, hardware details, steps to reproduce) +- Feature requests (describe your idea and use case) +- General questions + +--- + +## Acknowledgments + +This project was first forked by [BitVenturesUSA/ESP32-CAM-ONVIF](). We appreciate their interest and contributions to the ESP32-CAM ONVIF community. + +--- + +## Code of Conduct + +We are committed to providing a welcoming and inclusive environment for all. +Please read and follow our [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md). + +--- + +Thank you for your contributions! +Together, we can make ESP32-CAM-ONVIF the best open-source ONVIF camera firmware for ESP32. +