diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index bcaa3450a..2932b8a94 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -29,6 +29,12 @@ pre-commit run --all-files git commit -m "xxxx" ``` +**Note**: We have configured pre-commit checks in github workflow. If this +check in your PR fails, please locally ① ensure that the relevant +dependencies of pre-commit are consistent with the project configuration +(which can be completed through `pre-commit clean` and `pre-commit install`); +and ② execute `pre before push -commit run --all-files`. + ## Build your own ops - Data-Juicer allows everybody to build their own ops. diff --git a/docs/DeveloperGuide_ZH.md b/docs/DeveloperGuide_ZH.md index eb5f8e2a6..b3349067b 100644 --- a/docs/DeveloperGuide_ZH.md +++ b/docs/DeveloperGuide_ZH.md @@ -28,6 +28,8 @@ pre-commit run --all-files git commit -m "" ``` +**注意**:我们在github workflow配置了pre-commit的检查。如果您的PR中该检查没通过,请在本地①确保pre-commit 的相关依赖与项目配置一致(可通过`pre-commit clean`和`pre-commit install`完成);②push前执行了`pre-commit run --all-files`. + ## 构建自己的算子 - Data-Juicer 支持每个人定义自己的算子。