From 80f3ae650c29cb0bbe7790adcfc524db91dd1647 Mon Sep 17 00:00:00 2001 From: dennis zhuang Date: Thu, 14 Aug 2025 11:48:05 +0800 Subject: [PATCH] docs: improve CONTRIBUTING.md (#6698) * docs: improve CONTRIBUTING.md Signed-off-by: Dennis Zhuang * chore: features Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * chore: adds features to Makefile Signed-off-by: Dennis Zhuang * chore: adds make commands Signed-off-by: Dennis Zhuang --------- Signed-off-by: Dennis Zhuang Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- CONTRIBUTING.md | 5 +++-- Makefile | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 261d6262b8..1bf1eb9a1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,8 +55,9 @@ GreptimeDB uses the [Apache 2.0 license](https://github.com/GreptimeTeam/greptim - To ensure that community is free and confident in its ability to use your contributions, please sign the Contributor License Agreement (CLA) which will be incorporated in the pull request process. - Make sure all files have proper license header (running `docker run --rm -v $(pwd):/github/workspace ghcr.io/korandoru/hawkeye-native:v3 format` from the project root). - Make sure all your codes are formatted and follow the [coding style](https://pingcap.github.io/style-guide/rust/) and [style guide](docs/style-guide.md). -- Make sure all unit tests are passed using [nextest](https://nexte.st/index.html) `cargo nextest run`. -- Make sure all clippy warnings are fixed (you can check it locally by running `cargo clippy --workspace --all-targets -- -D warnings`). +- Make sure all unit tests are passed using [nextest](https://nexte.st/index.html) `cargo nextest run --workspace --features pg_kvbackend,mysql_kvbackend` or `make test`. +- Make sure all clippy warnings are fixed (you can check it locally by running `cargo clippy --workspace --all-targets -- -D warnings` or `make clippy`). +- When modifying sample configuration files in `config/`, run `make config-docs` (which requires Docker to be installed) to update the configuration documentation and include it in your commit. #### `pre-commit` Hooks diff --git a/Makefile b/Makefile index bcaadbd421..b178195d96 100644 --- a/Makefile +++ b/Makefile @@ -22,7 +22,7 @@ SQLNESS_OPTS ?= ETCD_VERSION ?= v3.5.9 ETCD_IMAGE ?= quay.io/coreos/etcd:${ETCD_VERSION} RETRY_COUNT ?= 3 -NEXTEST_OPTS := --retries ${RETRY_COUNT} +NEXTEST_OPTS := --retries ${RETRY_COUNT} --features pg_kvbackend,mysql_kvbackend BUILD_JOBS ?= $(shell which nproc 1>/dev/null && expr $$(nproc) / 2) # If nproc is not available, we don't set the build jobs. ifeq ($(BUILD_JOBS), 0) # If the number of cores is less than 2, set the build jobs to 1. BUILD_JOBS := 1