From 27f125fc20a797124face038be35d9a9f1cbbc34 Mon Sep 17 00:00:00 2001 From: manuzhang Date: Thu, 30 Nov 2023 00:34:04 +0800 Subject: [PATCH 1/2] chore: Add cargo build and build guide --- CONTRIBUTING.md | 20 ++++++++++++++++++++ Makefile | 3 +++ 2 files changed, 23 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76566df58..be5959367 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,6 +108,26 @@ $ cargo version cargo 1.69.0 (6e9a83356 2023-04-12) ``` +## Build + +### Compile + +```shell +make build +``` + +### Lint + +```shell +make check +``` + +### Test + +```shell +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 From a21380766dae9dff910a95791750f20c2e16d867 Mon Sep 17 00:00:00 2001 From: manuzhang Date: Mon, 4 Dec 2023 11:19:08 +0800 Subject: [PATCH 2/2] Make guide more concise --- CONTRIBUTING.md | 20 +++----------------- 1 file changed, 3 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index be5959367..712e7e27d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -110,23 +110,9 @@ cargo 1.69.0 (6e9a83356 2023-04-12) ## Build -### Compile - -```shell -make build -``` - -### Lint - -```shell -make check -``` - -### Test - -```shell -make test -``` +* To compile the project: `make build` +* To check code styles: `make check` +* To run tests: `make test` ## Code of Conduct