Skip to content

Update env and robot contribution guide#194

Merged
yuecideng merged 1 commit intomainfrom
yueci/add-contribute
Mar 22, 2026
Merged

Update env and robot contribution guide#194
yuecideng merged 1 commit intomainfrom
yueci/add-contribute

Conversation

@yuecideng
Copy link
Contributor

@yuecideng yuecideng commented Mar 22, 2026

Description

Same as title.

Type of change

  • Documentation update

Screenshots

Please attach before and after screenshots of the change if applicable.

Checklist

  • I have run the black . command to format the code base.
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • Dependencies have been updated, if applicable.

Copilot AI review requested due to automatic review settings March 22, 2026 16:17
@yuecideng yuecideng added the docs Improvements or additions to documentation label Mar 22, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the contribution guide to point contributors to the published documentation for adding robots and creating new Gym environments, replacing previous TODO placeholders.

Changes:

  • Add a link to the “Adding a New Robot” documentation in the robots contribution section.
  • Add links to the “Embodied Environments” page plus basic/modular environment tutorials.
  • Add a link to the task template repository for creating tasks in a separate repo.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


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.
Comment on lines +107 to +108
- [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)
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.
@yuecideng yuecideng merged commit f8d2b57 into main Mar 22, 2026
9 checks passed
@yuecideng yuecideng deleted the yueci/add-contribute branch March 22, 2026 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants