Skip to content

Commit

Permalink
[Doc] Move all contribution info to getting-involved.html and link to…
Browse files Browse the repository at this point in the history
… it from CONTRIBUTING.rst (ray-project#19571)
  • Loading branch information
architkulkarni committed Oct 25, 2021
1 parent 6081cf8 commit 2c64b2b
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 30 deletions.
27 changes: 1 addition & 26 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,8 @@ You can post questions or issues or feedback through the following channels:
To contribute a patch:
----------------------

1. Break your work into small, single-purpose patches if possible. It's much
harder to merge in a large change with a lot of disjoint features.
2. Submit the patch as a GitHub pull request against the master branch.
3. Make sure that your code passes the unit tests.
4. Make sure that your code passes the linter. Run setup_hooks.sh to create
a git hook that will run the linter before you push your changes.
5. Add new unit tests for your code.
We welcome your contribution! Please see https://docs.ray.io/en/master/getting-involved.html for instructions.

.. _`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

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!
30 changes: 26 additions & 4 deletions doc/source/getting-involved.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,38 @@ There are a couple steps to merge a contribution.
git remote add upstream https://github.com/ray-project/ray.git
git pull . upstream/master
2. Make sure all existing tests `pass <getting-involved.html#testing>`__.
2. Make sure all existing `tests <getting-involved.html#testing>`__ and `linters <getting-involved.html#lint-and-formatting>`__ pass.
Run ``setup_hooks.sh`` to create a git hook that will run the linter before you push your changes.
3. If introducing a new feature or patching a bug, be sure to add new test cases
in the relevant file in `ray/python/ray/tests/`.
in the relevant file in ``ray/python/ray/tests/``.
4. Document the code. Public functions need to be documented, and remember to provide an usage
example if applicable.
5. Request code reviews from other contributors and address their comments. During the review
example if applicable. See ``doc/README.md`` for instructions on editing and building public documentation.
5. Address comments on your PR. During the review
process you may need to address merge conflicts with other changes. To resolve merge conflicts,
run ``git pull . upstream/master`` on your branch (please do not use rebase, as it is less
friendly to the GitHub review tool. All commits will be squashed on merge.)
6. Reviewers will merge and approve the pull request; be sure to ping them if
the pull request is getting stale.

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 the `@author-action-required` label if further actions are required.
- Address their comments and remove the `@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 the `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 of PRs will be actively engaging with contributors to merge the PR.
- Please actively ping assignees after you address your comments!

Testing
-------

Expand Down Expand Up @@ -189,6 +209,8 @@ In addition, there are other formatting and semantic checkers for components lik
./ci/travis/check-git-clang-tidy-output.sh
You can run ``setup_hooks.sh`` to create a git hook that will run the linter before you push your changes.

Understanding CI test jobs
--------------------------

Expand Down

0 comments on commit 2c64b2b

Please sign in to comment.