Contributing to YOLO

Thank you for your interest in contributing to this project! We value your contributions and want to make the process as easy and enjoyable as possible. Below you will find the guidelines for contributing.

Quick Links

Testing and Formatting

We strive to maintain a high standard of quality in our codebase:

Testing: We use pytest for testing. Please add tests for new code you create.
Formatting: Our code follows a consistent style enforced by isort for imports sorting and black for code formatting. Run these tools to format your code before submitting a pull request.

GitHub Actions

We utilize GitHub Actions for continuous integration. When you submit a pull request, automated tests and formatting checks will run. Ensure that these checks pass for your pull request to be accepted.

How to Contribute

Proposing Enhancements

For feature requests or improvements, open an issue with:

A clear title and description.
Explain why this enhancement would be useful.
Considerations or potential implementation details.

Pull Request Checklist

Before sending your pull request, always check the following:

The code follows the Python style guide.
Code and files are well organized.
All tests pass.
New code is covered by tests.
We would be very happy if gitmoji😆 could be used to assist the commit message💬!

Code Review Process

Once you submit a PR, maintainers will review your work, suggest changes if necessary, and merge it once it’s approved.

Your contributions are greatly appreciated and vital to the project's success!

Please feel free to contact [email protected]!