Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

chore: Update contributing guide. #163

Merged
merged 1 commit into from
Jan 12, 2024
Merged

chore: Update contributing guide. #163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ The fastest way is:

### Bring your own toolbox

#### Install rust

iceberg-rust is primarily a Rust project. To build iceberg-rust, you will need to set up Rust development first. We highly recommend using [rustup](https://rustup.rs/) for the setup process.

For Linux or MacOS, use the following command:
Expand All @@ -108,11 +110,20 @@ $ cargo version
cargo 1.69.0 (6e9a83356 2023-04-12)
```

#### Install docker

Currently, iceberg-rust uses docker to set up environment for integration tests.

You can learn how to install docker from [here](https://docs.docker.com/get-docker/).

For macos users, you can install [OrbStack](https://orbstack.dev/) as a docker alternative.

## Build

* To compile the project: `make build`
* To check code styles: `make check`
* To run tests: `make test`
* To run unit tests only: `make unit-test`
* To run all tests: `make test`

## Code of Conduct

Expand Down
Loading