48 lines (31 loc) · 1.16 KB

Set up dev environment

Install nix
Fork and clone the repository

gh repo fork --clone --remote ibis-project/ibis-substrait

Set up public ibis-substrait Cachix cache to pull pre-built dependencies:

nix-shell -p cachix --run 'cachix use ibis-substrait'

Run nix-shell in the checkout directory

cd ibis-substrait
nix-shell

Building the library

nix develop '.#release' --extra-experimental-features nix-command --extra-experimental-features flakes -c poetry build

Writing commit messages

ibis-substrait follows the Conventional Commits structure. In brief, the commit summary should look like:

fix(types): make all floats doubles

The type (e.g. fix) can be:

fix: A bug fix. Correlates with PATCH in SemVer
feat: A new feature. Correlates with MINOR in SemVer
docs: Documentation only changes
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

If the commit fixes a Github issue, add something like this to the bottom of the description:
```
fixes #4242
```