Skip to content

Commit

Permalink
docs: update contributor guide (format toml/inte test) (#9301)
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveLauC authored Feb 22, 2024
1 parent cf11a70 commit 91f3eb2
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion docs/source/contributor-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
```

0 comments on commit 91f3eb2

Please sign in to comment.