Skip to content

Commit c623fc8

Browse files
Update CONTRIBUTING.md
1 parent 9678464 commit c623fc8

File tree

1 file changed

+3
-13
lines changed

1 file changed

+3
-13
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,11 @@ There are many ways you can contribute to `robot_descriptions`. Here are some id
99

1010
Make sure that your pull request satisfies the following:
1111

12-
- The file name for the new submodule is ``<robot_name>_description.py`` in snake-case. For example, ``R2D2_description`` becomes ``r2d2_description.py``.
1312
- The robot description is distributed legally and under an open source license (permissive or copyleft)
13+
- The file name for the new submodule is ``<robot_name>_description.py`` in snake-case. For example, ``R2D2_description`` becomes ``r2d2_description.py``
14+
- If applicable, add the repository containing the new description to ``_repositories.py``
15+
- If release tags are not available, use a specific git commit ID. This way the imported submodule will still work in the interval between a change in the file structure of the target repository and the corresponding update in `robot_descriptions`.
1416
- All three ``MESHES_PATH``, ``PATH`` and ``URDF_PATH`` fields are set
15-
- Add an entry to the [changelog](CHANGELOG.md) under "New models": ``- ROBOT_NAME robot_type (license: LICENSE)``
16-
17-
Checkout the specific tag of the latest release
18-
19-
```python
20-
__version__ = "1.1.0"
21-
__repo__ = _clone_to_cache(REPOSITORY_NAME)
22-
__repo__.git.checkout(f"v{__version__}")
23-
```
24-
25-
If release tags are not available in the target robot description, use a specific git commit ID. This way the imported submodule will still work in the interval between a change in the file structure of the target repository and the corresponding update in `robot_descriptions`.
26-
2717
- Add the submodule name to ``DESCRIPTION_NAMES`` in ``_descriptions.py``
2818
- Document the model's submodule name in the Models section of the [README](README.md)
2919
- Report the new model to the [changelog](CHANGELOG.md)

0 commit comments

Comments
 (0)