50 lines
2.2 KiB
ReStructuredText
50 lines
2.2 KiB
ReStructuredText
Contributing to Ray
|
|
===================
|
|
|
|
Reporting bugs and asking questions
|
|
-----------------------------------
|
|
|
|
You can post questions or issues or feedback through the following channels:
|
|
|
|
1. `Discourse forum`_: For discussions about development and questions about usage.
|
|
2. `GitHub Issues`_: For bug reports and feature requests.
|
|
3. `StackOverflow`_
|
|
|
|
Finding issues to work on
|
|
-------------------------
|
|
|
|
We use GitHub labels to categorize issues and help contributors find work that matches their interests. See `What can I work on?`_ for a list of labels by component and type.
|
|
|
|
To contribute a patch:
|
|
----------------------
|
|
|
|
We welcome contributions! See `Getting Involved`_. To set up your development environment, see
|
|
the `Setting up your development environment`_ section.
|
|
|
|
|
|
.. _`Discourse forum`: https://discuss.ray.io/
|
|
.. _`GitHub Issues`: https://github.com/ray-project/ray/issues
|
|
.. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray
|
|
.. _`Getting Involved`: https://docs.ray.io/en/latest/ray-contribute/getting-involved.html
|
|
.. _`Setting up your development environment`: https://docs.ray.io/en/latest/ray-contribute/getting-involved.html#setting-up-your-development-environment
|
|
.. _`What can I work on?`: https://docs.ray.io/en/latest/ray-contribute/getting-involved.html#what-can-i-work-on
|
|
|
|
PR Review Process
|
|
-----------------
|
|
|
|
For contributors who are in the ray-project organization:
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
- When you first create a PR, add a reviewer to the `assignee` section.
|
|
- Assignees will review your PR and add `@author-action-required` label if further actions are required.
|
|
- Address their comments and remove `@author-action-required` label from the PR.
|
|
- Repeat this process until assignees approve your PR.
|
|
- 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.
|
|
- Committers will merge the PR once the build is passing.
|
|
|
|
For contributors who are not in the ray-project organization:
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
- Your PRs will have assignees shortly. Assignees or PRs will be actively engaging with contributors to merge the PR.
|
|
- Please actively ping assignees after you address your comments!
|