Skip to content

Latest commit

 

History

History
78 lines (57 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

78 lines (57 loc) · 3.34 KB
Raw

Contributing to Lale

Lale is an open-source project, and we appreciate your help!

To make contributions to this GitHub repository, please submit a pull request (PR). Please ensure that your new functionality is adequately covered by the regression test suite. In addition, we expect contributors to submit a "Developer's Certificate of Origin" by signing the following form: DCO1.1.txt.

One suggested contribution is adding more operators. Furthermore, we recently gave a webinar as part of the "Open Source Directions" series by Quansight. Among other things, the webinar discusses possible contributions and future directions. So if you are interested in contributing and are looking for inspiration, go check it out!

The development workflow for Lale resembles that of other open-source projects on Github. The following visualization shows how to submit a PR:

development workflow

Italics in the visualization indicate parts you have to substitute: user (your user name), email (your email associated with github), feature (the name of the feature branch you are working on), and message (a description of your commit).

We have a pre-commit hook setup to help ensure that your code is properly formatted and passes various static checks. We highly recommend that you enable it, or at least run the check before submitting a PR. To do so, install the pre-commit python package (this is done automatically if you pip install -e .[dev]). Run pre-commit install in your lale repository to enable pre-commit checking, or pre-commit run --all-files to just run the checks once.

Some committers have experienced difficulties with the Pyright pre-commit checks, since they require npm. You can skip this check locally by running SKIP=pyright git commit ...; of course, the check will still be performed by the continuous integration tests in GitHub Actions.

Making a Lale Release

Every successful build automatically creates a release on test PyPI, which can be installed via pip install -i https://test.pypi.org/simple/ lale.

To make a release on public PyPI, which can be installed via pip install lale, perform the following two steps:

  1. Increment the version string.

    • The version string is stored in lale/__init__ (as an example, here is a prior version).

    • As described above, submit a PR with the change.

    • Once the tests have passed, rebase the PR onto master.

  2. Create a Github Release

    • Go to the Releases page.

    • Click Draft a New Release.

    • For the Tag version, use vVERSION. For example, if you put "0.4.8" as the version in the code, then the tag would be v0.4.8.

    • Add a title for the release.

    • Add a description of key changes in this release.

    • Click Publish Release.

    • You are done! The release will be automatically deployed to public PyPI.