Contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be included in future Bytewax releases :sparkles:.

This contributing guide is for the bytewax core GitHub repo. If you are interested in contributing a connector, please see the connector hub documentation that explains how to contribute a community connector to the Connector Hub.

Before continuing, please Read our Code of Conduct to keep our community approachable and respectable.

Also read the Developer Certificate of Origin to ensure you are in compliance.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Getting started

Bytewax is a Python library backed by Rust code. The codebase is split between Python code in pysrc/bytewax and Rust code in src. PyO3 is used as the interface between the two. Core bytewax operators and the execution of dataflows are handled at the Rust layer. These are the building blocks for the operators written in the Python layer.

To develop with Bytewax locally you will need to install Rust and use Maturin to build the code into a Python module locally.

Issues

Create a new issue

If you spot a problem with Bytewax, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue template.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. By default, we won't assign issues to any contributors that are not maintainers. If you find an issue to work on, you are welcome to open a PR with a fix.

Important Labels: Good First Issue - These are a good entry point for contributing to Bytewax. Help Wanted - These are issues we are looking for the community to help contribute to.

Make Changes

Make changes locally

  1. Fork the repository.
  2. Install Rust (check version). We recommend using rustup to manage your installation.
  3. Install Maturin pip install maturin (please check the version)
  4. Run maturin develop -E dev
  5. Test your changes locally.
  6. If possible, add a test that will run with CI. :bow:

Commit your update

Commit the changes once you are happy with them. Be sure to sign your commit if using the command line interface.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Apply the "Ready for review" label so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations :tada::tada: The Bytewax community thanks you! :sparkles:.

Once your PR is merged, your contributions will be included in the next release ๐Ÿ˜„. See the release process docs for more information on how that is managed. A maintainer will run the release.

In this article