Contributing to Score LeRobot Episodes

September 8, 2025 ยท View on GitHub

Thank you for your interest in contributing to this project! This guide will help you get started.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch for your changes
  4. Make your changes
  5. Test your changes
  6. Submit a pull request

Development Setup

  1. Install dependencies:

    pip install -r requirements.txt

  2. Set up your development environment according to the project's needs.

Making Changes

  • Keep changes focused and atomic
  • Write clear, descriptive commit messages
  • Follow the existing code style and conventions
  • Add tests for new functionality when applicable
  • Update documentation as needed

Submitting Pull Requests

  1. Push your changes to your fork
  2. Create a pull request against the main branch
  3. Provide a clear description of your changes
  4. Reference any related issues

Code Style

  • Follow PEP 8 for Python code
  • Use meaningful variable and function names
  • Add docstrings for functions and classes
  • Keep functions focused and concise

Testing

Run tests before submitting your pull request to ensure everything works correctly.

Questions?

If you have questions about contributing, please open an issue or reach out to the maintainers.