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
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,11 +11,14 @@ This project's goal is to facilitate loading and sharing of robot descriptions f
11
11
12
12
Make sure that your pull request satisfies the following:
13
13
14
-
- The robot description is distributed legally and under an open source license (permissive or copyleft)
15
-
- The file name for the new submodule is ``<robot_name>_description.py`` in snake-case. For example, ``R2D2_description`` becomes ``r2d2_description.py``
16
-
- If needed, add the repository containing the new description to ``_repositories.py``.
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``.
17
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`.
18
-
- Add the description metadata to the ``DESCRIPTIONS`` dictionary in ``_descriptions.py``
19
-
- Check that all unit tests are successful by ``tox -e py3X`` where ``3.X`` is the version of your Python interpreter
20
-
- Document the description's submodule name in the Descriptions section of the [README](README.md)
21
-
- Write down the new model to the [changelog](CHANGELOG.md)
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
+
5.**Testing:** Check that all unit tests are successful by ``tox -e py``.
23
+
6.**README:** Document the description's submodule name in the Descriptions section of the [README](README.md).
24
+
7.**Changelog:** Write down the new model to the [changelog](CHANGELOG.md).
0 commit comments