CONTRIBUTING.rst 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. Contributing to Ray
  2. ===================
  3. Reporting bugs and asking questions
  4. -----------------------------------
  5. You can post questions or issues or feedback through the following channels:
  6. 1. `Github Discussions`_: For discussions about development, questions about usage, and feature requests.
  7. 2. `GitHub Issues`_: For bug reports and feature requests.
  8. 3. `StackOverflow`_
  9. To contribute a patch:
  10. ----------------------
  11. We welcome your contribution! Please see https://docs.ray.io/en/master/getting-involved.html for instructions.
  12. For instructions on setting up your development environment, check out the
  13. `getting involved`_ documentation page.
  14. .. _`Github Discussions`: https://github.com/ray-project/ray/discussions
  15. .. _`GitHub Issues`: https://github.com/ray-project/ray/issues
  16. .. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray
  17. .. _`getting involved`: https://docs.ray.io/en/master/getting-involved.html
  18. PR Review Process
  19. -----------------
  20. For contributors who are in the ray-project organization:
  21. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22. - When you first create a PR, add an reviewer to the `assignee` section.
  23. - Assignees will review your PR and add `@author-action-required` label if further actions are required.
  24. - Address their comments and remove `@author-action-required` label from the PR.
  25. - Repeat this process until assignees approve your PR.
  26. - Once the PR is approved, the author is in charge of ensuring the PR passes the build. Add `test-ok` label if the build succeeds.
  27. - Committers will merge the PR once the build is passing.
  28. For contributors who are not in the ray-project organization:
  29. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  30. - Your PRs will have assignees shortly. Assignees or PRs will be actively engaging with contributors to merge the PR.
  31. - Please actively ping assignees after you address your comments!