This is an automated email from the ASF dual-hosted git repository.
xushiyan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hudi-rs.git
The following commit(s) were added to refs/heads/main by this push:
new 9319c4e chore: add more dev commands and update the project's short
description (#217)
9319c4e is described below
commit 9319c4e4c6d02f7fe2e853a98c87c551a89c3cb7
Author: Shiyan Xu <[email protected]>
AuthorDate: Fri Dec 6 13:03:18 2024 -1000
chore: add more dev commands and update the project's short description
(#217)
---
.asf.yaml | 2 +-
CONTRIBUTING.md | 4 ++--
README.md | 2 +-
python/Makefile | 19 +++++++++++++++++++
4 files changed, 23 insertions(+), 4 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 30dc422..c9e747a 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -21,7 +21,7 @@
# https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
github:
- description: "A native Rust library for Apache Hudi, with bindings into
Python"
+ description: "The native Rust implementation for Apache Hudi, with Python
API bindings."
homepage: https://hudi.apache.org/
labels:
- apache
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 319022a..22e933f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -93,13 +93,13 @@ pytest tests/test_table_read.py -s -k
"test_read_table_has_correct_schema"
Run test commands to make sure the code is working as expected:
```shell
-make test-rust test-python
+make test
```
Run check commands and follow the suggestions to fix the code:
```shell
-make check-rust check-python
+make check
```
## Create a pull request
diff --git a/README.md b/README.md
index fc48865..2bc0fa8 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@
</a>
</p>
<p align="center">
- A native Rust library for Apache Hudi, with bindings to Python
+ The native Rust implementation for Apache Hudi, with Python API bindings.
<br>
<br>
<a href="https://github.com/apache/hudi-rs/actions/workflows/ci.yml";>
diff --git a/python/Makefile b/python/Makefile
index 0a8d69a..948631e 100644
--- a/python/Makefile
+++ b/python/Makefile
@@ -41,6 +41,22 @@ develop: setup ## Install Python binding of hudi-rs
$(info --- Develop with Python binding ---)
maturin develop --extras=devel,pandas $(MATURIN_EXTRA_ARGS)
+.PHONY: format
+format: format-rust format-python ## Format Rust and Python code
+
+.PHONY: format-rust
+format-rust: ## Format Rust code
+ $(info --- Format Rust code ---)
+ cargo fmt --all
+
+.PHONY: format-python
+format-python: ## Format Python code
+ $(info --- Format Python code ---)
+ ruff format .
+
+.PHONY: check
+check: check-rust check-python ## Run check on Rust and Python
+
.PHONY: check-rust
check-rust: ## Run check on Rust
$(info --- Check Rust clippy ---)
@@ -57,6 +73,9 @@ check-python: ## Run check on Python
$(info --- Check Python typing ---)
mypy .
+.PHONY: test
+test: test-rust test-python ## Run tests on Rust and Python
+
.PHONY: test-rust
test-rust: ## Run tests on Rust
$(info --- Run Rust tests ---)
