-
Notifications
You must be signed in to change notification settings - Fork 837
Closed
Labels
HappyOpenSource快乐开源活动issue与PR快乐开源活动issue与PRPFCCPaddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfccPaddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc
Description
motivation : #6158
为了使开发者在 paddle 以及下游 repo 拥有一致的代码风格体验,需要进行 doc repo代码风格检查工具对齐。
此 issue 主要拆解并完成此任务。
每一步添加和修改工具都进行配置选择、存量修复、增量检查
升级 docs repo 中现有的代码风格检查工具版本
- black [CodeStyle] upgrade
black
in.pre-commit-config.yaml
#6238 - pre-commit/pre-commit-hooks(监控全部文件)[CodeStyle] upgrade
pre-commit/pre-commit-hooks
in.pre-commit-config.yaml
#6239 - Lucas-C/pre-commit-hooks(监控全部文件)[CodeStyle] upgrade
Lucas-C/pre-commit-hooks
in.pre-commit-config.yaml
#6240
移除重复的 pre-commit hooks
- forbid-crlf(包含于 remove-crlf)[CodeStyle] upgrade
Lucas-C/pre-commit-hooks
in.pre-commit-config.yaml
#6240 - forbid-tabs(包含于 remove-tabs)[CodeStyle] upgrade
Lucas-C/pre-commit-hooks
in.pre-commit-config.yaml
#6240 - check-whitespace-between-cn-and-en-char(包含于 insert-whitespace-between-cn-and-en-char)[CodeStyle] remove
check-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 进行静态检查,发现如下问题需要修复
序号 | 错误码 | 存量 | 认领人/状态/PR |
---|---|---|---|
1 | F541 | 28 | @ooooo-create |
2 | I001 | 14 | C419 |
3 | UP032 | 12 | C414 |
4 | F401 | 11 | UP008 |
5 | UP025 | 6 | W291 |
6 | W291 | 3 | |
7 | PLR1722 | 3 | @ooooo-create |
8 | C403 | 2 | @ooooo-create |
9 | C405 | 2 | @ooooo-create |
10 | UP004 | 2 | @ooooo-create |
11 | UP008 | 2 | @ooooo-create #6258 |
12 | C414 | 1 | @ooooo-create #6264 |
13 | C416 | 1 | @ooooo-create |
14 | C419 | 1 | @ooooo-create #6262 |
15 | E401 | 1 | @ooooo-create |
16 | E711 | 1 | @ooooo-create |
17 | E712 | 1 | @ooooo-create |
18 | F811 | 1 | @ooooo-create |
19 | F821 | 1 | @ooooo-create |
20 | PLR1701 | 1 | @ooooo-create #6247 |
21 | UP031 | 1 | @ooooo-create |
任务说明
对应文件 pyproject.toml
删除 tool.ruff.ignore
中对应的错误码
常用命令
# 安装 ruff pip install ruff # 自动修复 ruff --select NPY003 . --fix # 手动修复 ruff --select PLR5501 . # 手动修复中...
PR提交
⭐️ 提交PR标题 ⭐️:[Docathon][CodeStyle Fix No.xxxx] enable $ERRNO rule
$N
代表任务序号,$ERRNO
代表错误码- 请在 pr 描述里 @ooooo-create ,并链接本
issue #6242
,会由任务 Leader @ooooo-create 进行任务一审,一审通过后由 @SigureMo 进行二审
Note
1. Issue 回复格式: 为了自动填写报名信息,需要在issue下回复报名信息,如果报名格式不正确,则会在comment区提示报名不正确,格式如下:
【报名】: 2、3、6-10
其中【报名】: 后直接是报名的赛题序号,多个赛题之间需要用中文顿号
、
分隔,多个连续赛题可以用横线
表示
Note
2. PR 标题格式:
[Docathon][CodeStyle Fix No.2、3、6-10]
PR的标题中以
[Docathon][CodeStyle Fix No.xxxx] 开头即可,程序会自动提取赛题编号并更新榜单。 一个PR也可以提交多个赛题,多个赛题间以
顿号或
横线`分隔,比如 No.2、3、6-10 赛题。
看板信息
任务方向 | 任务数量 | 提交作品 / 任务认领 | 提交率 | 完成 | 完成率 |
---|---|---|---|---|---|
Docathon | 21 | 18 / 19 | 85.71% | 18 | 85.71% |
优化 pre-commit 在 CI 显示效果
整理 .pre-commit-config.yaml
配置,优化各个 hook 的顺序
优化 ci 里各项检查的显示效果,使得根据报错信息直观找对问题所在
统计信息
排名不分先后 @ooooo-create (18)
Metadata
Metadata
Assignees
Labels
HappyOpenSource快乐开源活动issue与PR快乐开源活动issue与PRPFCCPaddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfccPaddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc