Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Move all contribution info to getting-involved.html and link to it from CONTRIBUTING.rst #19571

Merged
merged 9 commits into from
Oct 25, 2021

Conversation

architkulkarni
Copy link
Contributor

Why are these changes needed?

The contribution guide is split across two sources which don't link to each other: https://github.com/ray-project/ray/blob/master/CONTRIBUTING.rst and https://docs.ray.io/en/latest/getting-involved.html. For example, setup_hooks.sh is only mentioned in the first one, but pip install -r python/requirements_linters.txt is only mentioned in the second one. As a result, most first time contributors need their hand to be held through the process of getting their first PR merged.

This PR establishes https://docs.ray.io/en/latest/getting-involved.html as the source of truth, linking to it from CONTRIBUTING.rst. Ideally a first-time contributor will be able to read this page and independently produce a mergeable PR.

Related issue number

Checks

  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@architkulkarni architkulkarni changed the title Unify contribution guide [Doc] Move all contribution info to getting-involved.html and link to it from CONTRIBUTING.rst Oct 21, 2021
Copy link
Contributor

@richardliaw richardliaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

@architkulkarni architkulkarni added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Oct 23, 2021
@edoakes edoakes merged commit 2c64b2b into ray-project:master Oct 25, 2021
@architkulkarni architkulkarni deleted the unify-contribution-guide branch October 25, 2021 20:07
@jjyao jjyao mentioned this pull request May 18, 2022
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tests-ok The tagger certifies test failures are unrelated and assumes personal liability.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants