Contribution Guide

Environment setup

With docker

  1. Fork the repository and git clone to your local machine.

  2. Build and access to docker container

docker compose build ubuntu
docker compose run --rm ubuntu bash

In case you want custom ruby or duckdb versions, use --build-arg options

docker compose build ubuntu --build-arg RUBY_VERSION=3.1.3 --build-arg DUCKDB_VERSION=1.0.0

Without docker

  1. Install Ruby into your local machine.

  2. Install duckdb into your local machine.

  3. Fork the repository and git clone to your local machine.

  4. Run bundle install

  5. Run rake build or you might run with C duckdb header and library directories: rake build -- --with-duckdb-include=/duckdb_header_directory --with-duckdb-lib=/duckdb_library_directory

Issue

If you spot a problem, search if an issue already exists. If a related issue doesn’t exist, you can open a new issue.

C Extension Development

For internal conventions when working on the C extension in ext/duckdb/ (function naming rules, extern/static guidelines, etc.), see HACKING.md.

When adding or modifying C extension code, follow the naming conventions described in HACKING.md.

Fix Issues or Add New Features.

  1. Run rake test

  2. Create new branch to change the code.

  3. Change the code.

  4. Write test.

  5. Run rake test and confirm all tests pass.

  6. Git push.

  7. Create PR.