Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

24 lines (19 loc) · 1.99 KB

👷 Contributing

PRs welcome Code style: black

The goal of this project is to facilitate loading and sharing of robot descriptions for the robotics community. All contributions are welcome. For example, here are some ways to help:

  • Add a new robot description
  • Raise any issue you find in a description, preferably directly in the description's repository (check out _repositories.py)
  • Make a standalone <robot_name>_description repository for a description embedded in one of the big framework repositories (Bullet, Drake, ...)

Adding a new robot description

  1. License: The robot description is distributed legally and under an open source license (permissive or copyleft).
  2. Repository: If needed, add the repository containing the new description to _repositories.py.
    • Use a specific git commit ID. This way the robot description will still work in the interval between a change in the file structure of the target repository and the corresponding update in robot_descriptions.
  3. Submodule: add a Python file for the robot descriptions to robot_descriptions/.
    • The file name for the new submodule is <robot_name>_description.py in snake-case.
    • For example, the file name for the Kinova (maker) Gen2 (robot name) is gen2_description.py.
    • Use the mj_description suffix for an MJCF description.
  4. Listing: Add the description metadata to the DESCRIPTIONS dictionary in _descriptions.py.
  5. README: Document the description's submodule name in the Descriptions section of the README.
  6. CHANGELOG: Write down the new model at the top of the changelog.
  7. Testing: Check that all unit tests are successful by tox.