Skip to content

How to contribute

Fernando Alzueta edited this page Sep 11, 2024 · 2 revisions

Contributing to Motion Detection with OpenCV

We welcome contributions to improve this project! Here are some ways you can contribute:

Reporting Issues

If you find any bugs or have suggestions for improvements, please open an issue on the GitHub Issues page.

Submitting Pull Requests

  1. Fork the repository.

  2. Create a new branch for your feature or bugfix:

git checkout -b issue-xxx

  1. Make your changes and commit them with clear and concise messages.

  2. Push your changes to your forked repository:

git push origin issue-xxx

  1. Open a pull request on the original repository.

Code Style

Please ensure your code follows the project's coding standards. We use pylint for code analysis. You can run pylint using the provided GitHub Actions workflow.

Running Tests

Before submitting your pull request, make sure all tests pass. You can run the tests using:

pylint $(git ls-files '*.py') --generated-members=cv2

Documentation

If you add new features, please update the documentation accordingly. This includes updating the README.md and any relevant comments in the code.

License

By contributing, you agree that your contributions will be licensed under the MIT License.


Additional Resources

  • OpenCV Documentation
  • Python Documentation

Thank you for your contributions and support!