[CodeStyle][Typos] 常见问题 FAQ&PR 注意事项

[MrXnneHang]

FAQ

是否一定要按照 typos 的建议来写？

Q1:

A-16 任务的正确拼写选项我觉得有更好的答案，我可以在修改文件时用自己认为的答案吗？

A:

可以，如果都按照默认 suggestion 那直接一个 PR 都修了，就是需要大家对每个都仔细判断下。

找不到_typos.toml文件.

Q2:

_typos.toml是需要自己创建吗还是在 typos 项目里打开，我在项目里没找到这个文件@Nyakku Shigure

A:

拉最新的 develop

Note

你应该先到自己 fork 的仓库sync fork,然后:

git switch develop -> git pull origin develop（如果失败了再提问哈）

完成特定单词后需要删除_typos.toml里对应的行:

比如你完成了recieves = "recieves"行，那么修复好typo就删除了该行。

如果碰到不确定的，可以和审核人讨论是否保留，如果选择保留的。

保留/忽略词汇的两种方式:

• 如果 typos 检测到的 typo 错误是被词典收录的自然词汇或者自然词汇的缩写（比如 algorithm 的缩写 algo ），那么请考虑直接把它移动到自定义词汇库:

[default.extend-words]
# PaddlePaddle specific words
algo = "algo"

• 该文件由于某些原因不能被修改。但是词汇本身在其他文件中应该被检查被修改，我们选择忽略该文件的 typo 检查来跳过 typos error：
  

具体配置方式:
同样在_typos.toml中:（以忽略tests/test_moelib.py为例）

[files] # 如果不存在需要自己添加，放在文件开头，而不是加到末尾。
extend-exclude = [
    "tests/test_moelib.py",
]

然后git add _typos.toml -> git commit -m add typos ignore file tests/test_moelib.py

如果被忽略的文件已经存在于暂存区，可能会阻塞提交，那么需要git restore --staged tests/test_moelib.py。

如何验证，在 tests/test_moelib.py 里面随便写一些错误单词，然后重复提交一下看看是否出现错误。。

Warning

总是优先检查你是否先提交了 _typos.toml 的配置，然后再测试提交被忽略文件。
以及，如果发现不行，请总是先验证是否该路径拼写正确。你可以尝试cat file_path

Ref:

• https://github.com/crate-ci/typos/blob/master/docs/reference.md#config-fields
• --exclude not working crate-ci/typos#1043

Git 常见问题:

Q3:

为什么 develop 分支无法被同步？/为什么 PR 时无法auto merge？

A:

你应该尽量保持自己的develop分支干净最新,把要提交的本次任务单独推送到feature_branch，不要覆盖develop,然后提交 PR

Note

建议对每次开始新任务前先参照Q2把分支同步一下。然后在 develop 分支执行：

git checkout -b recieves(你本次修改的任务标识)

push 的时候不要覆盖develop，git push origin recieves

这样你仓库会多一个recieves branch,你可以把它 PR 到 Paddle

什么是涉及API的修改？

Q4:

什么是涉及 API 的修改？单词不清楚要不要修改应该什么时候提问？

A:

涉及 API 名称变动。如果不是很清楚什么是 api 的话，可以先理解为，碰到函数名称，类名称需要被修改的时候就不要修改。然后按照 PR 模板说明，让审核人进行判断。

源码是可以动的，放心动。

Warning

third_party 不要动。

如何重新运行 CI:

Q5:

为什么 CI 好多 failed。

A:

你可以试试先到 Details 里面把它重新构建一次,有时候是网络问题，有时候是 CI 在维护更新，当然，有时候是你自己的问题=-=。

签署 CLA 后 CI 依然没有运行:

PR

模板

### PR Category
<!-- One of [ User Experience | Execute Infrastructure | Operator Mechanism | CINN | Custom Device | Performance Optimization | Distributed Strategy | Parameter Server | Communication Library | Auto Parallel | Inference | Environment Adaptation ] --> 

User Experience


### PR Types
<!-- One of [ New features | Bug fixes | Improvements | Performance | BC Breaking | Deprecations | Docs | Devs | Not User Facing | Security | Deprecations | Others ] -->

Devs

### Description

Fix:

- addess (-> address) 括号内可选 ## 我的意思是，括号里可以不写的(>_<)
- adjancent
- afer

Undo:

- algorithem 涉及 API 名称变动
- alogrithm 不是很确定

Note

注意，对于 Undo 的单词，你可以在它附近注释上一行Undo:alogrithm,这样它会出现你在 PR file changes 中。

如果真的不是很确定的这个而时候提交的时候统一提问。审核会认真看。

没有按照 PR 模板写的大概率会被 Close 或者不被搭理，如果你太久都没人来 review 你应该先考虑一下你自己的问题=-=。

PR 标题：

[CodeStyle][Typos][A-[11-19]] Fix typo (***) # 顿号分隔，如果超出标题长度，可以考虑`...`截断。

这很重要，标题写错了可能统计不到。

注意:

Warning

这部分请不要偷偷加空格，会影响正则，导致统计不到。

[CodeStyle][Typos][A-[11-19]]

如何修改PR信息:

另外，标题也是可以重命名的。

最后：

为了防止重复问同类型问题：

常见类型问题优先在这个 Issue 下面提问。我会补充到 FAQ 中。

优先在这个 Issue 里提问，特别是 CI,git,PR 类型的问题。

[MrXnneHang]

• [CodeStyle][Typos][A-N] ✏️ Typos 工具引入计划 #69441
• [CodeStyle][Typos][O-W] ✏️ Typos 工具引入计划 #69442

优先问我=-=，大佬们都比较忙。

[WAYKEN-TSE]

请问PR-CI-Model-benchmark出错了该怎么解决

[MrXnneHang]

如果你看到类似file not Found,git fatal failed,no such directory之类的字眼。
一般就是服务器问题，选择重构就行。重构几次都不行的话可能是CI在维护。
CI也不用特别关注，除非挂一大片，那需要重构一下。审核人觉得没问题就行。

[WAYKEN-TSE]

如果你看到类似file not Found,git fatal failed,no such directory之类的字眼。 一般就是服务器问题，选择重构就行。重构几次都不行的话可能是CI在维护。 CI也不用特别关注，除非挂一大片，那需要重构一下。审核人觉得没问题就行。

感谢，那如何查看审核结果呢

[MrXnneHang]

耐心等审核人回复，你也可以再报名其他的，新增其他PR。

[WAYKEN-TSE]

耐心等审核人回复，你也可以再报名其他的，新增其他PR。

好滴，谢谢

[XavierZXY]

PR模板这里可能需要改一下，不然pr check过不去

### PR Category
<!-- One of [ User Experience | Execute Infrastructure | Operator Mechanism | CINN | Custom Device | Performance Optimization | Distributed Strategy | Parameter Server | Communication Library | Auto Parallel | Inference | Environment Adaptation ] -->


### PR Types
<!-- One of [ New features | Bug fixes | Improvements | Performance | BC Breaking | Deprecations | Docs | Devs | Not User Facing | Security | Deprecations | Others ] -->

### Description

Fix:

- addess (-> address) 括号内可选 ## 我的意思是，括号里可以不写的(>_<)
- adjancent
- afer

Undo:

- algorithem 涉及 API 名称变动
- alogrithm 不是很确定

[MrXnneHang]

好的，感谢提醒。
确实第一个似乎没有Others

[yuan20041218]

commit提交之后没有触发预检测是正常的吗

[MrXnneHang]

commit提交之后没有触发预检测是正常的吗

是没有任何的pre-commit在运行吗？还是只有typos。如果是前一种，试一下:

pre-commit clean
pre-commit install
pre-commit run all-file

[BaolanChen]

git swicth develop中的swicth的字打错了吧，应该是switch

[MrXnneHang]

好的，感谢提醒🙏