如何為 🤗 LeRobot 做出貢獻

歡迎所有人參與貢獻，我們重視每個人的貢獻。程式碼並非幫助社群的唯一途徑。回答問題、幫助他人、主動溝通以及改進文件，這些都非常有價值。

無論您選擇哪種方式貢獻，請務必遵守我們的行為準則 (code of conduct) 與我們的人工智慧政策 (AI policy)。

貢獻方式

您可以透過多種方式進行貢獻：

• 修復問題： 解決程式錯誤或改進現有程式碼。
• 新功能： 開發新功能。
• 擴充： 實作新的模型/策略、機器人或模擬環境，並將資料集上傳至 Hugging Face Hub。
• 文件： 改進範例、指南及 docstrings。
• 反饋： 提交有關錯誤或期望新功能的工單 (tickets)。

如果您不確定該從哪裡開始，請加入我們的 Discord 頻道。

開發環境設定

若要貢獻程式碼，您需要設定開發環境。

1. Fork 與 Clone

在 GitHub 上 Fork 儲存庫，然後將您的 Fork 版本 clone 下來。

git clone https://github.com/<your-handle>/lerobot.git
cd lerobot
git remote add upstream https://github.com/huggingface/lerobot.git

2. 環境安裝

請遵循我們的安裝指南 (Installation Guide) 進行環境設定與原始碼安裝。

執行測試與品質檢查

程式碼風格 (Pre-commit)

安裝 pre-commit 鉤子，以便在您提交 (commit) 前自動執行檢查。

pre-commit install

若要對所有檔案手動執行檢查：

pre-commit run --all-files

執行測試

我們使用 pytest。首先，確保透過安裝 git-lfs 取得測試成品 (test artifacts)。

git lfs install
git lfs pull

執行完整測試套件（這可能需要安裝額外的套件）：

pytest -sv ./tests

或者在開發期間執行特定的測試檔案：

pytest -sv tests/test_specific_feature.py

提交 Issues 與 Pull Requests

請使用模板來填寫必要欄位並提供範例。

• Issues： 請遵循工單模板 (ticket template)。
• Pull requests： 請基於 upstream/main 進行 rebase，使用具描述性的分支名稱（請勿直接在 main 分支工作），並在本地端執行 pre-commit 與測試，同時請遵循 PR 模板。

LeRobot 團隊的成員隨後將會審核您的貢獻。

感謝您為 LeRobot 做出貢獻！