Skip to content

Commit

Permalink
added consistency instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
yxdyc committed Nov 14, 2023
1 parent a1b6b1f commit dae7cda
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/DeveloperGuide_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ pre-commit run --all-files
git commit -m "<your_commit_message>"
```

**注意**:我们在github workflow配置了pre-commit的检查。如果您的PR中该检查没通过,请在本地①确保pre-commit 的相关依赖与项目配置一致(可通过`pre-commit clean``pre-commit install`完成);②push前执行了`pre-commit run --all-files`.

## 构建自己的算子

- Data-Juicer 支持每个人定义自己的算子。
Expand Down

0 comments on commit dae7cda

Please sign in to comment.