-
Notifications
You must be signed in to change notification settings - Fork 454
Contributing
Peter Corke edited this page Dec 22, 2020
·
7 revisions
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 conventions
- tested before submission, and has unit tests for the new functionality
- Additional DH convention models, there are lots from the MATLAB version that haven't been ported across
- DHFactor
- More trajectory generators, perhaps multiple point to point
- Backends for CoppeliaSim, ROS, Dynamixels
- Mobile robotics functions are on branch Kristin-dev-updated, and are modelled on the MATLAB version but have no test code or documentation
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.
- Frequently asked questions (FAQ)
- Documentation Style Guide
- Typing 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
- Common Issues
- Contributors