-
Notifications
You must be signed in to change notification settings - Fork 759
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docathon]docs 代码风格检查工具对齐 Paddle #6242
Labels
HappyOpenSource
快乐开源活动issue与PR
PFCC
Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc
Comments
paddle-bot
bot
added
the
PFCC
Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc
label
Oct 23, 2023
ooooo-create
changed the title
[task] docs 代码风格检查工具对齐 Paddle
[Docathon] docs 代码风格检查工具对齐 Paddle
Oct 24, 2023
ooooo-create
changed the title
[Docathon] docs 代码风格检查工具对齐 Paddle
[Docathon]docs 代码风格检查工具对齐 Paddle
Oct 24, 2023
【报名】: 18-19 |
This was referenced Oct 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
HappyOpenSource
快乐开源活动issue与PR
PFCC
Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc
motivation : #6158
为了使开发者在 paddle 以及下游 repo 拥有一致的代码风格体验,需要进行 doc repo代码风格检查工具对齐。
此 issue 主要拆解并完成此任务。
每一步添加和修改工具都进行配置选择、存量修复、增量检查
升级 docs repo 中现有的代码风格检查工具版本
black
in.pre-commit-config.yaml
#6238pre-commit/pre-commit-hooks
in.pre-commit-config.yaml
#6239Lucas-C/pre-commit-hooks
in.pre-commit-config.yaml
#6240移除重复的 pre-commit hooks
Lucas-C/pre-commit-hooks
in.pre-commit-config.yaml
#6240Lucas-C/pre-commit-hooks
in.pre-commit-config.yaml
#6240check-whitespace-between-cn-and-en-char
in.pre-commit-config.yaml
#6241补全 Paddle 中启用但 docs 中未引入的 pre-commit hook,ruff(包含 isort
参考 Paddle repo 的 pyproject.toml 和 PaddleSOT repo 的pyproject.toml,补全
pyproject.toml
并在pre-commit hook
中添加最新版本的 ruff hook。在本地使用 ruff 进行静态检查,发现如下问题需要修复
任务说明
对应文件
pyproject.toml
删除
tool.ruff.ignore
中对应的错误码常用命令
PR提交
⭐️ 提交PR标题 ⭐️:[Docathon][CodeStyle Fix No.xxxx] enable $ERRNO rule
$N
代表任务序号,$ERRNO
代表错误码issue #6242
,会由任务 Leader @ooooo-create 进行任务一审,一审通过后由 @SigureMo 进行二审Note
1. Issue 回复格式: 为了自动填写报名信息,需要在issue下回复报名信息,如果报名格式不正确,则会在comment区提示报名不正确,格式如下:
Note
2. PR 标题格式:
看板信息
优化 pre-commit 在 CI 显示效果
整理
.pre-commit-config.yaml
配置,优化各个 hook 的顺序优化 ci 里各项检查的显示效果,使得根据报错信息直观找对问题所在
统计信息
The text was updated successfully, but these errors were encountered: