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 78a558f docs: update CONTRIBUTING with minor changes (#58) 78a558f is described below commit 78a558f00c8a6c4556db5ee98f26369fd90fabcf Author: Sagar Sumit <sagarsumi...@gmail.com> AuthorDate: Wed Jul 10 05:10:56 2024 +0530 docs: update CONTRIBUTING with minor changes (#58) Corrected typos and linked to source files for clarity. --------- Co-authored-by: Shiyan Xu <2701446+xushi...@users.noreply.github.com> --- CONTRIBUTING.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0698faa..5a451d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,25 +25,32 @@ platform. This guide will walk you through the process of making your first cont ## File an issue Testing and reporting bugs are also valueable contributions. Please follow -the [issue template](https://github.com/apache/hudi-rs/issues/new?template=bug_report.md) to file bug reports. +the [issue template](https://github.com/apache/hudi-rs/issues/new?template=bug_report.yml) to file bug reports. ## Prepare for development - Install Rust, e.g. as described [here](https://doc.rust-lang.org/cargo/getting-started/installation.html) -- Have a compatible Python version installed (check `python/pyproject.toml` for current requirement) +- Have a compatible Python version installed (check [`python/pyproject.toml`](./python/pyproject.toml) for current + requirement) ## Commonly used dev commands -For most of the time, use dev commands specified in `python/Makefile`, it applies to both Python and Rust modules. You -don't need to -CD to the root directory and run `cargo` commands. +For most of the time, use dev commands specified in [`python/Makefile`](./python/Makefile), it applies to both Python +and Rust modules. You don't need to `cd` to the root directory and run `cargo` commands. To setup python virtual env, run ```shell -make setup-env +make setup-venv ``` +> [!NOTE] +> This will run `python` command to setup the virtual environment. You can either change that to `python3.X`, +> or simply alias `python` to your local `python3.X` installation, for example: +> ```shell +> echo "alias python=/Library/Frameworks/Python.framework/Versions/3.12/bin/python3" >> ~/.zshrc` +> ``` + Once activate virtual env, build the project for development by ```shell