Skip to content

Latest commit

 

History

History
91 lines (68 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

91 lines (68 loc) · 2.52 KB

Contributing to Runhouse

Please file an issue if you encounter a bug.

If you would like to submit a bug-fix or improve an existing feature, please submit a pull request following the process outlined below.

If you would like to contribute, but don't know what to add, you can look for open issues labeled good first issue, or take a look at the funhouse repo to create and add your own ML application using Runhouse!

Development Process

If you want to modify code, please follow the instructions for creating a Pull Request.

  1. Fork the Github repository, and then clone the forked repo to local.
git clone [email protected]:<your username>/runhouse.git
cd runhouse
git remote add upstream https://github.com/run-house/runhouse.git
  1. Create a new branch for your development changes:
git checkout -b branch-name
  1. Install Runhouse
pip install -e .

  1. Develop your features

  2. Download and run pre-commit to automatically format your code using black and ruff.

pip install pre-commit
pre-commit run --files [FILES [FILES ...]]
  1. Add, commit, and push your changes. Create a "Pull Request" on GitHub to submit the changes for review.
git push -u origin branch-name

Testing

To run tests, please install pytest.

pip install pytest

Additional optional packages to install to run related tests:

aws related tests

  • awscli==1.25.60
  • boto3==1.24.59
  • pycryptodome==3.12.0

google related tests

  • google-api-python-client
  • google-cloud-storage
  • gcsfs

table tests

  • datasets
  • dask

Documentation

Docs source code is located in docs/. To build and review docs locally:

pip install -r docs/requirements.txt
cd docs/
make clean html

If updating or adding a notebook or colab file, please follow the following steps:

  • export the notebook into a .ipynb file, such as <insert_notebook_name>.ipynb
  • add/update the notebook file under docs/notebooks
  • get the .rst formatted notebook using the CLI command jupyter nbconvert --to rst <insert_notebook_name>.ipynb
  • move the .rst file into the correct directory in the docs directory
  • add the following lines under the rst file title to link out to the generated colab
.. raw:: html

    <p><a href="https://colab.research.google.com/github/run-house/runhouse/blob/default/docs/notebooks/<insert_notebook_name>.ipynb">
    <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a></p>