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
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,19 +7,19 @@ The goal of this project is to facilitate loading and sharing of robot descripti
7
7
8
8
-[Add a new robot description](#adding-a-new-robot-description)
9
9
- Raise any issue you find in a description, preferably directly in the description's repository (check out [`_repositories.py`](https://github.com/stephane-caron/robot_descriptions.py/blob/main/robot_descriptions/_repositories.py))
10
-
- Make a standalone ``<robot_name>_description`` repository for a description embedded in one of the big framework repositories (Bullet, Drake, ...)
10
+
- Make a standalone `<robot_name>_description` repository for a description embedded in one of the big framework repositories (Bullet, Drake, ...)
11
11
12
12
## Adding a new robot description
13
13
14
14
1.**License:** The robot description is distributed legally and under an open source license (permissive or copyleft).
15
-
2.**Repository:** If needed, add the repository containing the new description to ``_repositories.py``.
15
+
2.**Repository:** If needed, add the repository containing the new description to `_repositories.py`.
16
16
- 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`.
17
-
3.**Submodule:** add a Python file for the robot descriptions to ``robot_descriptions/``.
18
-
- The file name for the new submodule is ``<robot_name>_description.py`` in snake-case.
19
-
- For example, the file name for the Kinova (maker) Gen2 (robot name) is ``gen2_description.py``.
20
-
- Use the ``mj_description`` suffix for an MJCF description.
21
-
4.**Listing:** Add the description metadata to the ``DESCRIPTIONS`` dictionary in ``_descriptions.py``.
17
+
3.**Submodule:** add a Python file for the robot descriptions to `robot_descriptions/`.
18
+
- The file name for the new submodule is `<robot_name>_description.py` in snake-case.
19
+
- For example, the file name for the Kinova (maker) Gen2 (robot name) is `gen2_description.py`.
20
+
- Use the `mj_description` suffix for an MJCF description.
21
+
4.**Listing:** Add the description metadata to the `DESCRIPTIONS` dictionary in `_descriptions.py`.
22
22
5.**README:** Document the description's submodule name in the Descriptions section of the [README](README.md).
23
23
- Use an [SPDX License Identifier](https://spdx.org/licenses/) in the License column.
24
24
6.**CHANGELOG:** Write down the new model at the top of the [changelog](CHANGELOG.md).
25
-
7.**Testing:** Check that all unit tests are successful by ``tox``.
25
+
7.**Testing:** Check that all unit tests are successful by `tox`.
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ Loading will automatically download the robot description if needed, and cache i
54
54
55
55
### Import as submodule
56
56
57
-
You can also import a robot description directly as a submodule of ``robot_descriptions``:
57
+
You can also import a robot description directly as a submodule of `robot_descriptions`:
58
58
59
59
```python
60
60
from robot_descriptions import my_robot_description
@@ -83,7 +83,7 @@ The import will automatically download the robot description if you don't have i
83
83
</dd>
84
84
</dl>
85
85
86
-
Some robot descriptions include additional fields. For instance, the ``iiwa14_description`` exports ``URDF_PATH_POLYTOPE_COLLISION`` with more detailed collision meshes.
86
+
Some robot descriptions include additional fields. For instance, the `iiwa14_description` exports `URDF_PATH_POLYTOPE_COLLISION` with more detailed collision meshes.
0 commit comments