Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/huggingface/lerobot/llms.txt

Use this file to discover all available pages before exploring further.

Everyone is welcome to contribute, and we value everybody’s contribution. Code is not the only way to help the community. Answering questions, helping others, reaching out, and improving the documentation are immensely valuable. Whichever way you choose to contribute, please be mindful to respect our code of conduct and our AI policy.

​
Ways to Contribute

You can contribute in many ways:
  • Fixing issues: Resolve bugs or improve existing code.
  • New features: Develop new features.
  • Extend: Implement new models/policies, robots, or simulation environments and upload datasets to the Hugging Face Hub.
  • Documentation: Improve examples, guides, and docstrings.
  • Feedback: Submit tickets related to bugs or desired new features.
If you are unsure where to start, join our Discord Channel.

​
Development Setup

To contribute code, you need to set up a development environment.

​
1. Fork and Clone

Fork the repository on GitHub, then clone your fork: 
git clone https://github.com/<your-handle>/lerobot.git
cd lerobot
git remote add upstream https://github.com/huggingface/lerobot.git

​
2. Environment Installation

Please follow our Installation Guide for the environment setup and installation from source.

​
Running Tests & Quality Checks

​
Code Style (Pre-commit)

Install pre-commit hooks to run checks automatically before you commit: 
pre-commit install
To run checks manually on all files: 
pre-commit run --all-files

​
Running Tests

We use pytest. First, ensure you have test artifacts by installing git-lfs: 
git lfs install
git lfs pull
Run the full suite (this may require extras installed): 
pytest -sv ./tests
Or run a specific test file during development: 
pytest -sv tests/test_specific_feature.py

​
Submitting Issues & Pull Requests

Use the templates for required fields and examples.
  • Issues: Follow the ticket template.
  • Pull requests: Rebase on upstream/main, use a descriptive branch (don’t work on main), run pre-commit and tests locally, and follow the PR template.
One member of the LeRobot team will then review your contribution.

​
Community Guidelines

Code of Conduct

Be respectful and inclusive in all interactions

AI Policy

Guidelines for AI-assisted contributions

Discord Community

Join discussions and get help from the community

GitHub Repository

View source code and submit issues
Thank you for contributing to LeRobot!

Build docs developers (and LLMs) love

Get started for freeTalk to us