Skip to content
New issue

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

[Docathon]docs 代码风格检查工具对齐 Paddle #6242

Closed
ooooo-create opened this issue Oct 23, 2023 · 1 comment · Fixed by #6274
Closed

[Docathon]docs 代码风格检查工具对齐 Paddle #6242

ooooo-create opened this issue Oct 23, 2023 · 1 comment · Fixed by #6274
Labels
HappyOpenSource 快乐开源活动issue与PR PFCC Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc

Comments

@ooooo-create
Copy link
Collaborator

ooooo-create commented Oct 23, 2023

motivation : #6158
为了使开发者在 paddle 以及下游 repo 拥有一致的代码风格体验,需要进行 doc repo代码风格检查工具对齐。
此 issue 主要拆解并完成此任务。

每一步添加和修改工具都进行配置选择存量修复增量检查

升级 docs repo 中现有的代码风格检查工具版本

移除重复的 pre-commit hooks

补全 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 #62744
2 I001 14 C419
3 UP032 12 C414
4 F401 11 UP008
5 UP025 6 W291
6 W291 3
7 PLR1722 3 @ooooo-create #62733
8 C403 2 @ooooo-create #62666
9 C405 2 @ooooo-create #62655
10 UP004 2 @ooooo-create #62599
11 UP008 2 @ooooo-create #6258
12 C414 1 @ooooo-create #6264
13 C416 1 @ooooo-create #62633
14 C419 1 @ooooo-create #6262
15 E401 1 @ooooo-create #62688
16 E711 1 @ooooo-create #62722
17 E712 1 @ooooo-create #62677
18 F811 1 @ooooo-create 1
19 F821 1 @ooooo-create #6271 #62699
20 PLR1701 1 @ooooo-create #6247
21 UP031 1 @ooooo-create #62555

任务说明
对应文件 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)

@paddle-bot paddle-bot bot added the PFCC Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc label Oct 23, 2023
@sunzhongkai588 sunzhongkai588 added the HappyOpenSource 快乐开源活动issue与PR label Oct 24, 2023
@ooooo-create ooooo-create changed the title [task] docs 代码风格检查工具对齐 Paddle [Docathon] docs 代码风格检查工具对齐 Paddle Oct 24, 2023
@ooooo-create ooooo-create changed the title [Docathon] docs 代码风格检查工具对齐 Paddle [Docathon]docs 代码风格检查工具对齐 Paddle Oct 24, 2023
@ooooo-create
Copy link
Collaborator Author

【报名】: 18-19

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
HappyOpenSource 快乐开源活动issue与PR PFCC Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants