This is an automated email from the ASF dual-hosted git repository.
xiaokang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-graphar.git
The following commit(s) were added to refs/heads/main by this push:
new f9b521d7 docs: add pre-commit guidelines and fetch test data via
submodule (#839)
f9b521d7 is described below
commit f9b521d7991c948f03249e4e1c59088cd995e086
Author: 姚军 <[email protected]>
AuthorDate: Tue Feb 10 10:40:59 2026 +0800
docs: add pre-commit guidelines and fetch test data via submodule (#839)
---
CONTRIBUTING.md | 12 ++++++++++++
cpp/README.md | 2 +-
2 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 781da7b4..3ed08254 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -50,6 +50,18 @@ like (where issue \#42 is the ticket you're working on):
```shell
$ git checkout -b 42-add-chinese-translations
```
+### pre-commit
+
+Install the python package `pre-commit` and run once `pre-commit install`.
+
+```
+pip install pre-commit
+pre-commit install
+pre-commit run # check staged files
+pre-commit run -a # check all files
+```
+
+This will set up a git pre-commit-hook that is executed on each commit and
will report the linting problems.
### GitHub Pull Requests
diff --git a/cpp/README.md b/cpp/README.md
index bdc8da6b..21709bf7 100644
--- a/cpp/README.md
+++ b/cpp/README.md
@@ -91,7 +91,7 @@ make -j8 # if you have 8 CPU cores, otherwise adjust,
use -j`nproc` for al
After building, you can run the unit tests with:
```bash
-git clone https://github.com/apache/incubator-graphar-testing.git testing #
download the testing data
+git submodule update --init --recursive # download the testing data
GAR_TEST_DATA=${PWD}/testing ctest
```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
