Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (48 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

71 lines (48 loc) · 2.27 KB

Contribution Guide

AI-assisted contribution

  • This project is compatible with AI-assisted development, and contributors are encouraged to use GitHub Copilot, Codex, or other coding agents.
  • The repository includes AI agent instructions in AGENTS.md and .agents/instructions/; use them as the source of truth when working with AI tools.
  • AI-assisted changes should still stay focused, reuse existing patterns, and be reviewed and validated before commit.

Install by editable mode

make install-editable

Install development requirements

make dev-env

Contribution workflow

  • Keep changes focused and validate only what matches the scope of the change.
  • Use the Makefile targets in this document as the default local workflow.
  • For commit messages and GitLab merge requests, follow the source-of-truth guidance in .agents/instructions/git.instructions.md.
  • Contributors may use an AI assistant to help stage changes, create commits, push branches, and open merge requests, as long as the resulting git history and MR content follow the repository instructions.
  • In particular, keep the commit title in the required <type>(<scope>): <Description>. format, include the structured multiline body, and use the same content for the final squash commit message and MR description.

Lint

make check-lint

Auto format

make auto-format

Type checking

pyright

Build docs

Make sure the development dependencies are installed first with make dev-env.

make doc

Run test

For the full repository test suite:

  • Make sure that Ray is installed and available in the active environment.
  • Export ROBO_ORCHARD_TEST_WORKSPACE to a workspace that contains the required assets used by kinematics and image tests.
  • If Ray is not running, you can start it with ray start --head.
make test

Acknowledgement

Our work is inspired by many existing robotics frameworks, such as OpenAI Gym, Robosuite, IsaacLab, PyTorch3D etc. We would like to thank all the contributors of all the open-source projects that we use in RoboOrchard.