CONTRIBUTING.md

Contributing to Substrait

Welcome!

Dependencies

There's no formal set of dependencies for Substrait, but here are some that are useful to have:

• buf for easy generation of proto serialization/deserialization code
• protoc, used by buf and usable independent of buf
• A Python environment with the website's requirements.txt dependencies installed if you want to see changes to the website locally

Commit Conventions

Substrait follows conventional commits for commit message structure. You can use pre-commit to check your messages for you, but note that you must install pre-commit using pre-commit install --hook-type commit-msg for this to work. CI will also lint your commit messages. Please also ensure that your PR title and initial comment together form a valid commit message; that will save us some work formatting the merge commit message when we merge your PR.

Examples of commit messages can be seen here.