From 171ad62e30c682f244a9757db1e2193504e77cd0 Mon Sep 17 00:00:00 2001 From: iasoon Date: Tue, 16 Nov 2021 00:34:18 +0100 Subject: [PATCH] Link to the documentation on contributing from CONTRIBUTING.rst (#19396) Co-authored-by: Richard Liaw --- CONTRIBUTING.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d5f7bca07..b7f9d558d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -15,6 +15,30 @@ To contribute a patch: We welcome your contribution! Please see https://docs.ray.io/en/master/getting-involved.html for instructions. +For instructions on setting up your development environment, check out the +`getting involved`_ documentation page. + + .. _`Github Discussions`: https://github.com/ray-project/ray/discussions .. _`GitHub Issues`: https://github.com/ray-project/ray/issues .. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray +.. _`getting involved`: https://docs.ray.io/en/master/getting-involved.html + +PR Review Process +----------------- + +For contributors who are in the ray-project organization: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- When you first create a PR, add an 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!