Skip to content

Update env and robot contribution guide #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yuecideng merged 1 commit into from
Mar 22, 2026
Merged

Update env and robot contribution guide #194

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,12 @@ A `CLAUDE.md` file is present at the root of this repository. Claude Code reads

## Contribute specific robots

TODO: Add instructions for contributing new robot models and its configurations.
To contribute a new robot, please check the documentation on [Adding a New Robot](https://dexforce.github.io/EmbodiChain/guides/add_robot.html).

## Contribute specific environments

To contribute a new environment:
To contribute a new environment, please check the documentation on [Embodied Environments](https://dexforce.github.io/EmbodiChain/overview/gym/env.html) and see the tutorial below:
- [Creating a Basic Environment](https://dexforce.github.io/EmbodiChain/tutorial/basic_env.html)
Copy link

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is trailing whitespace at the end of this Markdown link line, which can cause markdownlint/pre-commit checks to fail and creates noisy diffs. Please remove the extra space after the closing parenthesis.

Suggested change
- [Creating a Basic Environment](https://dexforce.github.io/EmbodiChain/tutorial/basic_env.html)
- [Creating a Basic Environment](https://dexforce.github.io/EmbodiChain/tutorial/basic_env.html)

Copilot uses AI. Check for mistakes.
- [Creating a Modular Environment](https://dexforce.github.io/EmbodiChain/tutorial/modular_env.html)
Comment on lines +107 to +108
Copy link

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new list uses - bullets, but the rest of this CONTRIBUTING.md consistently uses * for unordered lists. For consistency (and to avoid lint/style inconsistencies), consider switching these bullets to match the existing style in this file.

Suggested change
- [Creating a Basic Environment](https://dexforce.github.io/EmbodiChain/tutorial/basic_env.html)
- [Creating a Modular Environment](https://dexforce.github.io/EmbodiChain/tutorial/modular_env.html)
* [Creating a Basic Environment](https://dexforce.github.io/EmbodiChain/tutorial/basic_env.html)
* [Creating a Modular Environment](https://dexforce.github.io/EmbodiChain/tutorial/modular_env.html)

Copilot uses AI. Check for mistakes.

TODO: Add instructions for contributing new environments.
If you want to implement your tasks in a new repo and with some customized functors and utilities, you can also use the [Task Template Repo](https://github.com/DexForce/embodichain_task_template).
Loading