Skip to content

Latest commit

 

History

History
31 lines (17 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

31 lines (17 loc) · 1.53 KB

Contributing to VLM Run Hub

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

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

Contributing Code

  1. Fork the Repository: Start by forking the repository and cloning it to your local machine.

  2. Set Up Your Development Environment: Follow the instructions in the README.md to set up your development environment.

  3. Create a Branch: Create a new branch for your feature or bug fix.

  4. Write Tests: Ensure your code is well-tested. We use pytest for testing.

  5. Submit a Pull Request: Once your changes are ready, submit a pull request. Make sure to follow the Schema Guidelines if your contribution involves schema changes.

Schema Contributions

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

Review Process

  • 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.

Thank you for contributing to the VLM Run Hub!