You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-13Lines changed: 3 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,21 +9,11 @@ There are many ways you can contribute to `robot_descriptions`. Here are some id
9
9
10
10
Make sure that your pull request satisfies the following:
11
11
12
-
- The file name for the new submodule is ``<robot_name>_description.py`` in snake-case. For example, ``R2D2_description`` becomes ``r2d2_description.py``.
13
12
- 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`.
14
16
- 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
-
27
17
- Add the submodule name to ``DESCRIPTION_NAMES`` in ``_descriptions.py``
28
18
- Document the model's submodule name in the Models section of the [README](README.md)
29
19
- Report the new model to the [changelog](CHANGELOG.md)
0 commit comments