We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Paddle 主 repo 由于有着大量的 C++ 和 Python 代码,因此代码风格检查工具的使用是必不可少的。Paddle repo 主要使用 pre-commit 作为管理工具,用于在 git commit 之前自动运行代码风格检查工具(见 .pre-commit-config.yaml,当然也可以参考 代码风格检查指南,但这里内容不保证是最新的),以保证提交的代码风格符合规范。
.pre-commit-config.yaml
随着 Paddle repo 中基础设施的不断完善,我们的代码风格检查工具也经历了几次升级,而其他下游 repo 大多没有及时跟进,会导致开发者在不同 repo 需要使用不同的代码风格,开发体验不一致,这其中就包含了 docs repo。因此本任务的目标就是更新 docs repo 代码风格检查工具,使之对齐 Paddle repo
black
pre-commit/pre-commit-hooks
Lucas-C/pre-commit-hooks
isort
ruff
forbid-crlf
remove-crlf
forbid-tabs
remove-tabs
check-whitespace-between-cn-and-en-char
insert-whitespace-between-cn-and-en-char
Important 本任务需要任务规划的拆解能力,虽然 docs 中代码不多,但每个工具的引入都需要从配置选择、存量修复、增量检查等多个方面进行考量
Important
本任务需要任务规划的拆解能力,虽然 docs 中代码不多,但每个工具的引入都需要从配置选择、存量修复、增量检查等多个方面进行考量
The text was updated successfully, but these errors were encountered:
pre-commit hook
Successfully merging a pull request may close this issue.
Motivation
Paddle 主 repo 由于有着大量的 C++ 和 Python 代码,因此代码风格检查工具的使用是必不可少的。Paddle repo 主要使用 pre-commit 作为管理工具,用于在 git commit 之前自动运行代码风格检查工具(见
.pre-commit-config.yaml
,当然也可以参考 代码风格检查指南,但这里内容不保证是最新的),以保证提交的代码风格符合规范。随着 Paddle repo 中基础设施的不断完善,我们的代码风格检查工具也经历了几次升级,而其他下游 repo 大多没有及时跟进,会导致开发者在不同 repo 需要使用不同的代码风格,开发体验不一致,这其中就包含了 docs repo。因此本任务的目标就是更新 docs repo 代码风格检查工具,使之对齐 Paddle repo
Task details
.pre-commit-config.yaml
),使之对齐 Paddle repo,这包含black
pre-commit/pre-commit-hooks
(监控全部文件)Lucas-C/pre-commit-hooks
(监控全部文件)isort
(请使用 ruff 中的 isort 功能替代)ruff
forbid-crlf
(包含于remove-crlf
)forbid-tabs
(包含于remove-tabs
)check-whitespace-between-cn-and-en-char
(包含于insert-whitespace-between-cn-and-en-char
)The text was updated successfully, but these errors were encountered: