Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 2.65 KB

File metadata and controls

72 lines (43 loc) · 2.65 KB

Contributing to YOLO From Scratch

Thank you for your interest in contributing to YOLO From Scratch! We appreciate all contributions, big and small. Here are some guidelines to help you get started.

How to Contribute

1. Fork the Project

Start by forking the repository on GitHub. This will allow you to have your own copy of the project to work on.

2. Create a Branch

Before you start working on a new feature or patch, create a new branch. Use a descriptive branch name:

git checkout -b feature/my-new-feature

3. Make Your Changes

Make your changes and make sure your code follows Python style conventions (PEP 8). You can use tools like flake8 or black to check the style of your code.

4. Add tests

If you add a new feature or fix a bug, please add tests to verify that your code works as expected. Tests should be placed in the tests directory.

5. Commit your changes

Commit your changes with a clear and descriptive commit message:

git commit -m "Adding feature X"

6. Push your changes

Push your changes to your fork:

git push origin feature/my-new-feature

7. Open a Pull Request

Go to the origin repository and open a Pull Request. Clearly describe the changes you made and why they are necessary. We will review your Pull Request as soon as possible.

Code of Conduct

We are committed to creating a welcoming and inclusive environment for all contributors. Please read our Code of Conduct to understand our expectations for behavior.

Questions?

If you have any questions or need help, feel free to open an issue or contact the development team.

Thanks again for your contribution to YOLO From Scratch! Your help is invaluable in improving this project.