Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ray-preview.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Ray welcomes contributions from anyone — bug reports, code, examples, and documentation.

Set up a dev environment

git clone https://github.com/ray-project/ray.git
cd ray
pip install -e "python[default]"
For C++ changes, build with Bazel:
bazel build //:all
See the project’s BUILD.rst for full build instructions.

Run tests

pytest python/ray/tests/test_basic.py
Run a specific test or test file matching the change you’re making.

Code style

  • Python: pyproject.toml configures ruff and black. Run ruff check and black . before submitting.
  • C++: clang-format with the repo config.

Open a pull request

  1. Fork the repo, create a branch, and push your changes.
  2. Open a PR. Use a clear title and a description that explains why the change is needed.
  3. Link to any related issue.
  4. Wait for CI; iterate based on feedback.

Documentation

Documentation lives in doc/source/. Edit Markdown or RST files and submit a PR. To preview locally:
cd doc
make html
open _build/html/index.html

Examples

Examples are welcome — small, self-contained, and runnable. Add them under doc/source/<library>/examples/ and link them from the relevant index.

Governance and code review

All PRs are reviewed by maintainers. The bar is correctness, tests, and consistency with existing patterns. Big changes are discussed first via issue or REP (Ray Enhancement Proposal).

Next steps

Governance

Project decision-making.

Community

Find help and discuss ideas.