Contribution Guide#

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

To get an overview of the project, read the README

Read our Code of Conduct to keep our community approachable and respectable.

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.

New To Open Source?#

Here are some resources to help you get started with open source contributions in general:


The Bytewax project keeps a log of work items on GitHub in the repo’s issues.

New Issues#

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.

Contribution Steps#

Fork and Clone#

Fork the canonical Bytewax repository. Then clone your fork to your local machine.

Setup Development Environment#

Follow the instructions in Local Development to setup your local development environment.

Modify and Commit#

Bytewax is a Python library backed by Rust code. The codebase is split between Python code in pysrc and Rust code in src.

The Python code base contains:

  • All public API interface definitions.

  • Most dataflow operators.

  • Most IO connectors.

The Rust code base contains:

  • Core Timely runtime.

  • Core Bytewax operators.

  • PyO3 interface to the runtime.

  • Recovery system machinery.

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.

  • Submit your PR as a “draft” if it is not ready for immediate review. Mark it as “ready to review” when ready.

  • 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 maintainer 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.


Congratulations 🎉🎉 The Bytewax community thanks you! ✨

Once your PR is merged, your contributions will be included in the next release 😄. A maintainer cuts new releases periodically.

Join our community Slack channel

Need some help? Join our community!

If you have any trouble with the process or have ideas about how to improve this document, come talk to us in the #questions-answered Slack channel!

Join now