Issue 2321: Add code formatting instructions to CONTRIBUTING (#2444)

* ehance documentation on how to format/check your code

* Update dev/format-code.sh

Co-authored-by: Raphael Taylor-Davies <[email protected]>

* Update dev/format-code.sh

Co-authored-by: Raphael Taylor-Davies <[email protected]>

* attempt to share lint infra

* corrected invalid /

* mention scripts in formatting instructions

Co-authored-by: Raphael Taylor-Davies <[email protected]>

Author: timvw

.github/workflows/rust.yml

@@ -307,7 +307,10 @@ jobs:
           rustup default stable
           rustup component add rustfmt
       - name: Run
-        run: cargo fmt --all -- --check
+        run: ci/scripts/rust_fmt.sh
+        env:
+          CARGO_HOME: "/github/home/.cargo"
+          CARGO_TARGET_DIR: "/github/home/target"
 
   clippy:
     name: Clippy
@@ -347,8 +350,7 @@ jobs:
         run: |
           rustup component add clippy
       - name: Run clippy
-        run: |
-          cargo clippy --all-targets --workspace -- -D warnings
+        run: ci/scripts/rust_clippy.sh
         env:
           CARGO_HOME: "/github/home/.cargo"
           CARGO_TARGET_DIR: "/github/home/target"
@@ -479,7 +481,7 @@ jobs:
           # check which Cargo.toml introduces formatting violation
           #
           # ignore ./Cargo.toml because putting workspaces in multi-line lists make it easy to read
-          find . -mindepth 2 -name 'Cargo.toml' -exec cargo tomlfmt -p {} \;
+          ci/scripts/rust_toml_fmt.sh
           git diff --exit-code
         env:
           CARGO_HOME: "/github/home/.cargo"

CONTRIBUTING.md

@@ -53,6 +53,16 @@ Testing setup:
 - `git submodule init`
 - `git submodule update`
 
+Formatting instructions:
+
+- [ci/scripts/rust_fmt.sh](ci/scripts/rust_fmt.sh)
+- [ci/scripts/rust_clippy.sh](ci/scripts/rust_clippy.sh)
+- [ci/scripts/rust_toml_fmt.sh](ci/scripts/rust_toml_fmt.sh)
+
+or run them all at once:
+
+- [dev/rust_lint.sh](dev/rust_lint.sh)
+
 ## Test Organization
 
 DataFusion has several levels of tests in its [Test

ci/scripts/rust_clippy.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+set -ex
+cargo clippy --all-targets --workspace -- -D warnings

ci/scripts/rust_fmt.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+set -ex
+cargo fmt --all -- --check

ci/scripts/rust_toml_fmt.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+set -ex
+find . -mindepth 2 -name 'Cargo.toml' -exec cargo tomlfmt -p {} \;

dev/rust_lint.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+set -e
+if ! command -v cargo-tomlfmt &> /dev/null; then
+    echo "Installing cargo-tomlfmt using cargo"
+    cargo install cargo-tomlfmt
+fi
+
+ci/scripts/rust_fmt.sh
+ci/scripts/rust_clippy.sh
+ci/scripts/rust_toml_fmt.sh