Repository navigation
Contributing
Contributions are welcome, and there is lots to do.
A contribution is ideally
- submitted as a pull request, which means it can be tested by the build system before it is merged, and adheres to the coding conventions
- well documented, using Sphinx + ReStructured Text and adheres to the documentation style guide
- tested before submission, and has unit tests for the new functionality
If you want to contribute, and you're thinking about a big chunk of work, post an issue with new feature tag, and we can discuss the approach before you invest too much time.
Open, unscoped feature/enhancement ideas are tracked as GitHub issues rather than listed here,
so they can be picked up, discussed and closed individually rather than going stale on a wiki
page. See issues labeled
enhancement —
in particular the clustered wishlists for
kinematics,
dynamics,
a CoppeliaSim backend,
backend API polish, and
misc housekeeping
(Dynamixel backend already exists, see Backends).
Mobile robotics support (roboticstoolbox.mobile: vehicle models, planners, EKF/particle-filter
localization, SLAM) has landed on main, with tests (tests/test_mobile.py,
tests/test_mobile_planner.py) and Sphinx docs. If you're looking for something to
contribute here, check open issues rather than assuming it's greenfield work.
- Frequently asked questions (FAQ)
- Documentation Style Guide
- Background
- Key concepts
- Introduction to robot and link classes
- Working with Jupyter
- Working from the command line
- What about Simulink?
- How to contribute
- Contributors
- Coding conventions