Overview

Our process follows a typical github project workflow.

• Fork our repos and download the code
• Hack on the code, making commits to the forked repos.
• Send us a pull request.

Always happy to accept patches, but we're also very interested in any new applications you may have written. Be sure to test them thoroughly and make sure they're stable before applying to have them accepted as part of the turtlebot core app suite.

Prerequisites

• A github account of your own.

Workflow

Forking

Development is currently split between catkin and non-catkin stacks that are identified by turtlebot_catkin.rosinstall and turtlebot.rosinstall.

• Identify the repos in the rosinstall files that you'd like to work on and fork them to your own account.

For example, if you want to hack on turtlebot_apps, go to turtlebot_apps on github and hit the Fork button on the top right.

Source Workspace

• Download the two rosinstall files and modify the forked repos, pointing to repos of your own.

• Follow the Source Installation tutorial, pointing it at your two locally modified rosinstall files instead of the originals.

Making a Pull Request

Hack on the code, making local commits. Keep in mind that when patching or making minor modifications keep your commits small as its easier to parse and accept small chunks.

When you're happy, push your commits to your forked repo and finally hit the Pull Request button at the top of your forked repo's page on github.

Instant Pull Requests

If you're just making one or two line modifications to a file, a simpler way to make a pull request is simply to first view the file in one of the turtlebot repo's and then click the Edit button to the top right of the file viewer. Make your modifications and then when you save, github will automagically make a fork and send a pull request to the repo owner - too easy!