GSoD20
This document describes a list of potential ideas created for the 2020 Google Season of Docs. However, the ideas are open to everyone with interest on collaborating, and Open Robotics is open to new ideas. If you would like to suggest new projects please message gsod AT osrfoundation.org.
The following list shows a set of ideas that can extend the documentation of the Ignition Robotics open source project led by OSRF.
Ignition Robotics is a suite of tools, libraries, and cloud services designed to iterate quickly on design concepts and robot control strategies. Ignition's leading robotics simulator, Gazebo, plays a central role by providing a robust and proven environment in which to create and test autonomous platforms.
Gazebo has a long history spanning over 16 years, from its humble origins as a research tool to it widespread use in industry and government institutions. Over this time Gazebo has proven itself in various virtual competitions, city and vehicle simulation, and aerial vehicle simulation.
The link between all the Ignition components is their open source nature and its relationship with robotics. Browse through the list and do not hesitate to contact us if you wish to participate in any of the projects. Share with us your thoughts and ideas on any future improvement or project you may have.
For a general introduction on how to start contributing to Ignition, check out the documentation! If you have any technical questions feel free to ask them at Gazebo Answers or message @HelloWorld at Gazebo Community.
- Prerequisites: Linux, Git, Markdown
- Nice-to-haves: C++, terminal commands
- Difficulty level: Medium
- List of potential mentors: Claire Wang, Marya Belanger
- Detailed description: Ignition Robotics has a rich suite of tools and libraries that are under active development. Since its migration to Github, we expect more external contributors along aside internal developers to be involved. While we currently have a contributing guide, it is very minimal. This project focuses on expanding the guide to include tools and tips that are used in developing and debugging ignition libraries, how to contribute, code style and programming conventions to follow and etc. A good example of the end-goal would look similar to ROS 2 Contributing Guide, with specific structure and design open to suggestions.
- Prerequisites: Linux, Git, Markdown
- Nice-to-haves: Physics, doxygen, C++
- Difficulty level: Hard
- List of potential mentors: Claire Wang, Steven Peters
- Detailed Description: Ignition Physics is the back-end of Ignition Gazebo simulation. It allows users to use external physics engine to power gazebo simulation. This project focuses on developing a set of tutorials on creating your own physics plugin that uses custom physics engine to power simulation, and improving current API documentation as mentioned in this issue. The goal of this project is to help ease the contribution barrier to current physics library, thus expand our support for different physics engines in the long run.