Contributing to VLM Run Hub

GitHub Issues: Use the GitHub Issues to report bugs or request features.
Discussions: Join our Discord forum for general questions and discussions.

We welcome contributions to the VLM Run Hub! Whether you're reporting bugs, suggesting features, or contributing code, your input is valuable to us.

Reporting Bugs and Asking Questions

Fork the Repository: Start by forking the repository and cloning it to your local machine.
Set Up Your Development Environment: Follow the instructions in the README.md to set up your development environment.
Create a Branch: Create a new branch for your feature or bug fix.
Write Tests: Ensure your code is well-tested. We use pytest for testing. Use make test to run all the tests.
Submit a Pull Request: Once your changes are ready, submit a pull request. Make sure to follow the Schema Guidelines if your contribution involves Pydantic schema changes.

For contributions involving Pydantic schemas, please refer to the Schema Guidelines for detailed instructions on creating and submitting schemas.

For Members: Assign a reviewer to your pull request. Address any feedback and ensure all tests pass before merging.
For Non-Members: A project member will be assigned to review your pull request. Please address their feedback promptly.

Before submitting your changes, ensure:

Make any relevant changes to the repository.
Run make lint to ensure your code is linted.
Add any relevant tests under tests/, and run make test to ensure all tests pass.
If you are contributing a new schema, follow the Contributing Schemas instead of the general contributing guidelines.

Thank you for helping us maintain high standards for schema contributions!