docs: opt contributiong.md #1356
Conversation
Walkthrough本次变更简化了 Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
CONTRIBUTING.md (1)
Line range hint
185-185: 改进格式说明将裸露的URL替换为链接格式，以提高可读性。
- Refer to https://yuque.antfin.com/mako/vz2gn4/vkp4qs8u4zcuxqoc for details. + Refer to [details](https://yuque.antfin.com/mako/vz2gn4/vkp4qs8u4zcuxqoc).
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CONTRIBUTING.md (3 hunks)
Additional context used
LanguageTool
CONTRIBUTING.md
[misspelling] ~122-~122: Possible spelling mistake found.
Context: ...ruments/mac). - Install Xcode App from Mac AppStore and switch xcode dev tool with: ```bas...(EN_MULTITOKEN_SPELLING_TWO)
Markdownlint
CONTRIBUTING.md
159-159: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
185-185: null
Bare URL used(MD034, no-bare-urls)
Additional comments not posted (21)
CONTRIBUTING.md (21)
7-7: 优化说明建议将“First of all, you need to install the following tools:”改为“You need to install the following tools:”，去掉冗余的“First of all”。
16-17: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
23-24: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
30-31: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
37-37: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
43-50: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
58-60: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
66-71: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
77-78: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
81-82: 改进格式说明将“Run fmt to format code.”改为“Use
just fmtto format the code.”，将“Run lint to check code style.”改为“Usejust lintto check the code style.”，使说明更清晰。
87-89: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
95-98: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
104-110: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
116-117: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
131-134: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
140-140: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
146-146: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
152-155: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
160-163: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
176-180: 去掉冗余的命令符号在命令前去掉“-$”，保持一致性和简洁性。
125-125: 拼写错误“xcode dev tool”应为“Xcode dev tool”。
- sudo xcode-select -s /Applications/Xcode.app/Contents/Developer + sudo xcode-select -s /Applications/Xcode.app/Contents/DeveloperLikely invalid or redundant comment.
|
I think bash command keep |
Okay, I'll add it back |
|
好像啥也没改？ |
回退多了，我重新提交了 |
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (4)
CONTRIBUTING.md (4)
7-7: 建议恢复命令前的$前缀移除命令前的
$前缀可能会降低清晰度。恢复$前缀可以更好地区分命令和输出。- git clone git@github.com:umijs/mako.git + $ git clone git@github.com:umijs/mako.git
Line range hint
15-15:
建议恢复命令前的$前缀移除命令前的
$前缀可能会降低清晰度。恢复$前缀可以更好地区分命令和输出。- cargo build + $ cargo build
81-82: 建议恢复命令前的$前缀移除命令前的
$前缀可能会降低清晰度。恢复$前缀可以更好地区分命令和输出。- just fmt + $ just fmt
Line range hint
121-121:
建议恢复命令前的$前缀移除命令前的
$前缀可能会降低清晰度。恢复$前缀可以更好地区分命令和输出。- npm run release + $ npm run release
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CONTRIBUTING.md (2 hunks)
Additional context used
Markdownlint
CONTRIBUTING.md
78-78: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
Summary by CodeRabbit
mako项目中的构建、测试、基准测试和性能分析命令。