Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ All notable changes to this project will be documented in this file.

- README: Alphabetize description tables (thanks to @nickswalker)
- Description: Alphabetize description tables (thanks to @nickswalker)
- README: Generate description tables from registry metadata and keep them alphabetized (thanks to @nickswalker)
- Description metadata: Add robot name, maker, DOF, repository, and license fields to the registry (thanks to @nickswalker)

### Fixed

- README: Correct and backfill license metadata (thanks to @nickswalker)

## [1.23.0] - 2026-03-09

Expand Down
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,21 @@ The goal of this project is to facilitate loading and sharing of robot descripti
- 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`.
- Include the metadata fields there as well: robot name, maker, DOF (when applicable), SPDX license identifier, and optionally the path to the license file in the source repository.
5. **Visualize:** At this point you can check that the new description loads and renders properly using a visualizer, for example:

```
uv run --with yourdfpy --with "pyglet<2" python -m robot_descriptions show_in_yourdfpy <new_description>
uv run --with mujoco-python-viewer python -m robot_descriptions show_in_mujoco <new_mj_description>
```

6. **README:** Document the description's submodule name in the Descriptions section of the [README](README.md).
- Use an [SPDX License Identifier](https://spdx.org/licenses/) in the License column.
6. **README:** Regenerate the Descriptions section of the [README](README.md):

```
python scripts/generate_readme_descriptions.py
```

- Use an [SPDX License Identifier](https://spdx.org/licenses/) in `license_spdx`.
- When you know the license file location, store its repository-relative path in `license_file` so the README link can be derived automatically.
7. **CHANGELOG:** Write down the new model at the top of the [changelog](CHANGELOG.md).
8. **Testing:** Check that all unit tests are successful by `tox`.
413 changes: 210 additions & 203 deletions README.md

Large diffs are not rendered by default.

Loading
Loading