Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 2.95 KB

getting_help.rst

File metadata and controls

74 lines (53 loc) · 2.95 KB
Raw

Getting Help

Searching For Your Question

If you need help with Drake, please first review the documentation on this website for things such as :ref:`installation <installation_and_quick_start>`, the C++ API, or :ref:`Python bindings <python-bindings>`.

Please also briefly review Drake's open and closed GitHub issues and StackOverflow posts tagged for Drake to see if your issue has been encountered by someone else before.

Asking Your Question

If you know your question is a bug or feature request, please post a GitHub issue.

Otherwise, if you are seeking assistance (e.g. tutorials or a brief example), please post a question on StackOverflow with the drake tag.

If you are actively developing with Drake and may need more active discussions than what StackOverflow and GitHub may offer, consider asking for access to the Drake Developers Slack Channel. To do so, please email Russ Tedrake for access. Please note that this access may not always be readily granted.

If you wish to contribute a patch, please see how to :ref:`submit a pull request <pull_request>`.

Helpful Information

When reporting an issue, please consider providing the following information (examples in italics):

  • Operating system (Ubuntu 18.04, macOS Catalina)
  • Language (C++, :ref:`Python <python-bindings>`)
    • C++ compiler (GCC 7.5.0, Clang 6.0.0)
    • Python version (Python 3.6.7)
    • Python distribution (apt, homebrew)
  • If building from source:
    • Build system (Bazel, CMake*)
      • Bazel version (which bazel; bazel version)
      • Bazel C++ compiler (bazel run @drake//common:print_host_settings)
      • CMake version (which cmake; cmake --version)
      • CMake C++ compiler (cmake -LA <path_to_source_dir> | grep 'CMAKE_.*_COMPILER')
    • Git revision (git rev-parse --short HEAD)
    • :ref:`Building Drake <build_from_source>` vs. downstream project (like drake_bazel_external, drake_cmake_external)
  • If using binary release:
    • Download URL
    • Contents of drake/share/doc/drake/VERSION.txt
    • Building downstream project (drake_cmake_installed)

Older Sources

Some information was previously on a mailing list. Please do not use these resources, as they are now inactive.