From ffa3a5ce385f13f951f335566fe33401fe9f0055 Mon Sep 17 00:00:00 2001 From: Manu Zhang Date: Thu, 7 Dec 2023 19:29:22 +0800 Subject: [PATCH] chore: Add cargo build and build guide (#111) * chore: Add cargo build and build guide * Make guide more concise --- CONTRIBUTING.md | 6 ++++++ Makefile | 3 +++ 2 files changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76566df58..712e7e27d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,6 +108,12 @@ $ cargo version cargo 1.69.0 (6e9a83356 2023-04-12) ``` +## Build + +* To compile the project: `make build` +* To check code styles: `make check` +* To run tests: `make test` + ## Code of Conduct We expect all community members to follow our [Code of Conduct](https://www.apache.org/foundation/policies/conduct.html). diff --git a/Makefile b/Makefile index 488171666..63fcb6473 100644 --- a/Makefile +++ b/Makefile @@ -15,6 +15,9 @@ # specific language governing permissions and limitations # under the License. +build: + cargo build + check-fmt: cargo fmt --all -- --check