Table of contents
If you have improvements to Drake, send us your pull requests!
Our standard workflow is to fork Drake's official Github repository into your own Github account and then push your changes into a branch on your fork. Once you believe your code is ready to be merged into Drake's primary repository, open a pull request via the Github website. Your code will then undergo an interactive review process and :ref:`Continuous Integration (CI) <continuous_integration_notes>` tests before it is merged into Drake's primary repository.
Drake's :ref:`CI service <continuous_integration_notes>` runs on all pull requests each time they are submitted and updated. Pull requests cannot be merged into master unless all unit tests pass on all :ref:`supported platform configurations <supported-configurations>`.
Drake's CI server also runs continuously on Drake's primary master branch using an even more comprehensive set of unit tests. If problems are detected on this branch, the build cop will :ref:`revert the PRs that most likely caused the problem <build_cop>`. To increase the likelihood that your pull requests pass CI tests and are not reverted, you can run the unit tests locally. Instructions for how to do that are provided :ref:`here <unit-test-instructions>`. Note, however, that there are many computationally-demanding tests and running the entire test suite can take several hours depending on your machine.
We would like to hear about your success stories if you've used Drake in your
own projects. Please consider contributing to our :doc:`gallery` by editing
doc/gallery.rst and submitting a pull request with the update!
Important note: Drake is an open source project licensed under extremely flexible terms intended to encourage use by anyone, for any purpose. When you make a contribution to the Drake project, you are agreeing to do so under those same terms.
.. toctree::
:maxdepth: 1
unit_testing_instructions
downstream_testing
The following table shows the configurations and platforms that Drake officially supports. Supported configurations are tested in continuous integration. All other configurations are provided on a best-effort basis.
Drake requires a compiler running in C++14 mode or greater. MATLAB is only supported for CMake builds using the "Unix Makefiles" generator.
| Operating System | Build System | C/C++ Compiler | Java | MATLAB (Optional) | Python |
|---|---|---|---|---|---|
| Ubuntu 16.04 LTS (Xenial Xerus) | Bazel 0.16.1
CMake 3.5.1
|
Clang 6.0
GCC 5.4
|
OpenJDK 8 | R2017a | 2.7.11 |
| Ubuntu 18.04 LTS (Bionic Beaver) | Bazel 0.17.2
CMake 3.10.2
|
Clang 6.0
GCC 7.3
|
OpenJDK 11 | R2018b | 2.7.15 |
| macOS High Sierra (10.13) | Bazel 0.17.2
CMake 3.12.2
|
Apple LLVM 10.0 | Oracle 11 | ||
| macOS Mojave (10.14) |
Ubuntu Bionic C++ and Python support is experimental and has limited testing in continuous integration. macOS Mojave C++ and Python support and macOS and Ubuntu Bionic MATLAB support is experimental and untested in continuous integration.
The binary releases of Drake are built with GCC 5.4 on Ubuntu Xenial and Apple LLVM 10.0 on macOS High Sierra.
The links for these packages are listed in :ref:`binary-installation`.
.. toctree::
:maxdepth: 1
issues
For complex changes, especially those that will span multiple PRs, please open a GitHub issue and solicit design feedback before you invest a lot of time in code.
Before your submit a pull request, please consult the :ref:`Code Review Checklist <code-review-checklist>`, where a list of the most frequent problems are collected.
Be prepared to engage in active code review on your pull requests. The Drake code review process has two phases: feature review and platform review. You are responsible for finding reviewers, and for providing them the information they need to review your change effectively. If a reviewer asks you for more information, that is a sign you should add more documentation to your PR.
A PR generally should not include more than 750 added or changed lines (the
green +### number as reported by github), and must not include more than
1500 lines, with the following exemptions:
- Data files do not count towards the line limit.
- Machine-generated changes do not count towards the line limit.
- Files in :ref:`Special Directories <directory_structure_special_directories>` do not count towards the line limit.
- This rule may be overridden by agreement of at least two platform reviewers (listed below).
The utility tools/prstat will report the total added or changed
lines, excluding files that are easily identified to meet the exemptions above.
We use https://reviewable.io for code reviews. You can sign in for free with your GitHub identity. Before your first code review, please take a look at :doc:`reviewable`.
Feature Review. After creating your pull request, assign it to someone else on your team for feature review. Choose the person most familiar with the context of your pull request. This reviewer is responsible for protecting your team by inspecting for bugs, for test coverage, and for alignment with the team's goals. During this review, you and your reviewer should also strive to minimize the number of changes that will be necessary in platform review.
Platform Review. After your feature reviewer has signed off on your change, reassign it to a Drake owner for platform review. The owner will inspect for architectural compatibility, stability, performance, test coverage, and style.
The following GitHub users are Drake owners. If possible, seek platform review from an owner who has previously reviewed related changes. Shared context will make the review faster.
- @EricCousineau-TRI (Toyota Research Institute)
- @ggould-tri (Toyota Research Institute)
- @jwnimmer-tri (Toyota Research Institute)
- @sammy-tri (Toyota Research Institute)
- @SeanCurtis-TRI (Toyota Research Institute)
- @sherm1 (Toyota Research Institute)
- @soonho-tri (Toyota Research Institute)
- @RussTedrake (MIT / Toyota Research Institute)
Merge. If you have write access to RobotLocomotion/drake, a green "Merge Pull Request" button will appear when your change is fully reviewed and passes CI. You may click it to merge your PR. If you do not have write access, or if you believe that status checks are failing for inconsequential reasons, ask your platform reviewer to perform the merge for you.
After Merge. If your PR breaks continuous integration, the :doc:`buildcop` will contact you to work out a resolution.
.. toctree::
:maxdepth: 1
reviewable
The user-facing instructions for requesting assistance are located in :ref:`getting_help`. The two main options for requesting assistance are either posting a GitHub issue or a StackOverflow question.
See :ref:`issues`.
If a GitHub issue should instead be a StackOverflow question (e.g. it is of a tutorial nature that does not require code or documentation modification), please request that the user repost the question on StackOverflow, post the new link on the GitHub issue, and close the issue.
Please subscribe to the drake tag by following
these general instructions,
if you are able to.
Please also monitor for unanswered StackOverflow posts
once per day. If there are unanswered questions that you are unsure of the
answer, consider posting on the Slack #onramp channel to see if someone
can can look into the question.
The following developers are subscribed to the drake tag, and will monitor
it:
- Russ Tedrake
- Eric Cousineau
.. toctree::
:maxdepth: 1
CDash <https://drake-cdash.csail.mit.edu/index.php?project=Drake>
jenkins
buildcop
.. toctree::
:maxdepth: 1
documentation_instructions
doxygen_instructions
sphinx_instructions
.. toctree::
:maxdepth: 1
clion
Eclipse <https://github.com/tkoolen/drake/wiki/Eclipse-setup-(experimental)>
sublime_text
unicode_tips_tricks
vim
.. toctree::
:maxdepth: 1
development_on_mac
.. toctree::
:maxdepth: 1
code_review_checklist
code_style_guide
code_style_tools
directory_structure
.. toctree::
:maxdepth: 1
no_push_to_origin