This is an automated email from the ASF dual-hosted git repository.
fokko pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-rust.git
The following commit(s) were added to refs/heads/main by this push:
new 18f63fe chore: Update contributing guide. (#163)
18f63fe is described below
commit 18f63fe9d5d4f0aa1db8dea1b4f591fadb7757d4
Author: Renjie Liu <[email protected]>
AuthorDate: Sat Jan 13 05:39:09 2024 +0800
chore: Update contributing guide. (#163)
---
CONTRIBUTING.md | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 712e7e2..8fae0bb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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:
@@ -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
