From 91f3eb2e5430d23e2b551e66732bec1a3a575971 Mon Sep 17 00:00:00 2001 From: SteveLauC Date: Thu, 22 Feb 2024 10:53:36 +0800 Subject: [PATCH] docs: update contributor guide (format toml/inte test) (#9301) --- docs/source/contributor-guide/index.md | 27 +++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/source/contributor-guide/index.md b/docs/source/contributor-guide/index.md index 3b0d4932c2cf..839055f6ed7a 100644 --- a/docs/source/contributor-guide/index.md +++ b/docs/source/contributor-guide/index.md @@ -202,7 +202,7 @@ There are several tests of the public interface of the DataFusion library in the You can run these tests individually using `cargo` as normal command such as ```shell -cargo test -p datafusion --test dataframe +cargo test -p datafusion --test parquet_exec ``` ## Benchmarks @@ -338,3 +338,28 @@ After you've confirmed your prettier version, you can format all the `.md` files ```bash prettier -w {datafusion,datafusion-cli,datafusion-examples,dev,docs}/**/*.md ``` + +## How to format `.toml` files + +We use `taplo` to format `.toml` files. + +For Rust developers, you can install it via: + +```sh +cargo install taplo-cli --locked +``` + +> Refer to the [Installation section][doc] on other ways to install it. +> +> [doc]: https://taplo.tamasfe.dev/cli/installation/binary.html + +```bash +$ taplo --version +taplo 0.9.0 +``` + +After you've confirmed your `taplo` version, you can format all the `.toml` files: + +```bash +taplo fmt +```