diff --git a/doc/source/getting-involved.rst b/doc/source/getting-involved.rst index 8229b37bd1cc1..51bc59f9e84b1 100644 --- a/doc/source/getting-involved.rst +++ b/doc/source/getting-involved.rst @@ -34,6 +34,21 @@ What can I work on? We use Github to track issues, feature requests, and bugs. Take a look at the ones labeled `"good first issue" `__ and `"help wanted" `__ for a place to start. + +Examples of features to contribute +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Tune +#### + +We encourage both the developers and users of optimization libraries to contribute +:ref:`tune-search-alg` to Tune wrapping around them. Search Algorithms allow Tune's users +to take advantage of algorithms contained in external libraries while benefitting from +a unified API and other Tune features. + +For implementation details, please refer to :ref:`byo-algo`. + + Setting up your development environment --------------------------------------- @@ -172,10 +187,10 @@ Understanding CI test jobs -------------------------- The Ray project automatically runs continuous integration (CI) tests once a PR -is opened using `Travis-CI `_ with +is opened using `Buildkite `_ with multiple CI test jobs. -The `Travis CI`_ test folder contains all integration test scripts and they +The `CI`_ test folder contains all integration test scripts and they invoke other test scripts via ``pytest``, ``bazel``-based test or other bash scripts. Some of the examples include: @@ -189,11 +204,11 @@ scripts. Some of the examples include: * ``pytest python/ray/serve/tests`` * ``python python/ray/serve/examples/echo_full.py`` -If a Travis-CI build exception doesn't appear to be related to your change, -please visit `this link `_ to +If a CI build exception doesn't appear to be related to your change, +please visit `this link `_ to check recent tests known to be flaky. -.. _`Travis CI`: https://github.com/ray-project/ray/tree/master/ci/travis +.. _`CI`: https://github.com/ray-project/ray/tree/master/ci/travis Becoming a Reviewer diff --git a/doc/source/tune/api_docs/suggestion.rst b/doc/source/tune/api_docs/suggestion.rst index b452121fefcb8..26122e48af0e6 100644 --- a/doc/source/tune/api_docs/suggestion.rst +++ b/doc/source/tune/api_docs/suggestion.rst @@ -294,6 +294,9 @@ If you are interested in implementing or contributing a new Search Algorithm, pr :private-members: :show-inheritance: + +If contributing, make sure to add test cases and an entry in the function described below. + .. _shim: Shim Instantiation (tune.create_searcher)