Contributing to Embucket

Learn how to contribute to Embucket through bug reports, feature requests, and pull requests

Embucket is a streamlined solution for building and managing an open lakehouse platform based on the Apache Iceberg open table format. This project is designed to be radically simple, focusing on ease of deployment, operation, and maintenance.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a Code of Conduct. Please follow it in all your interactions with the project.

We appreciate every contribution, whether it’s fixing bugs, improving documentation, or adding new features — your efforts help make this project better for everyone.

Development Environment Setup

To set up a development environment, please follow these steps:

1. Clone the repository

   Clone the Embucket/embucket repository from GitHub:

   git clone https://github.com/Embucket/embucket.git
   cd embucket/
   
2. Build the project

   Build the project using Cargo:

   cargo build
   

For more detailed development setup and coding standards, see the Development Guide.

Issues and Feature Requests

You’ve found a bug in the source code, a mistake in the documentation, or maybe you’d like a new feature? You can help us by submitting an issue or even better, a pull request.

Before you create an issue, make sure to search the issue archive — your issue may have already been addressed!

Creating Quality Bug Reports

Please try to create bug reports that are:

Reproducible

Include steps to reproduce the problem

Specific

Include as much detail as possible: which version, what environment, etc.

Unique

Do not duplicate existing opened issues

Scoped

One bug per report

Even better: Submit a pull request with a fix or new feature!

Pull Request Process

Follow these steps to submit a pull request:

1. Search for existing PRs

   Search our repository for open or closed Pull Requests that relate to your submission. You don’t want to duplicate effort.

2. Fork the project

   Create your own fork of the repository on GitHub.

3. Create a feature branch

   Create your feature branch with a descriptive name:

   git checkout -b issueID/new_feature
   
4. Commit your changes

   Commit your changes with a clear message referencing the issue ID:

   git commit -m 'issue id: New Feature'
   
5. Push to your branch

   Push your changes to your forked repository:

   git push origin issueID/new_feature
   
6. Open a Pull Request

   Open a Pull Request on GitHub with a detailed description of your changes.

7. Ensure tests pass

   Your pull request build must pass. The build will run automatically when you submit your PR.

Coding Conventions

When coding in Rust, please follow the coding conventions outlined in our development guide.

Consistent coding style helps maintain code quality and makes it easier for everyone to contribute.

Getting Help

For discussions, questions, or collaboration, feel free to reach out via:

GitHub Discussions

Ask questions and discuss ideas with the community

GitHub Issues

Report bugs and request features

We appreciate your contributions and look forward to working with you!