Skip to content
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

docs: intall cargo #1332

Closed
wants to merge 1 commit into from
Closed

docs: intall cargo #1332

wants to merge 1 commit into from

Conversation

liangchaofei
Copy link
Contributor

@liangchaofei liangchaofei commented Jun 28, 2024

Summary by CodeRabbit

  • 文档
    • 添加了安装 cargo 的说明。
    • 添加了关于在 umi 或 bigfish 中使用 Xcode instruments 进行性能分析的备注。

Copy link
Contributor

coderabbitai bot commented Jun 28, 2024

Walkthrough

这次修改增加了在CONTRIBUTING.md中安装cargo的说明,并在umi或bigfish中进行性能分析时增加了关于使用Xcode instruments的备注。对导出或公共实体的声明未作任何修改。

Changes

文件 修改摘要
CONTRIBUTING.md 添加了安装cargo的说明,并增加了使用Xcode instruments进行性能分析的备注

Poem

小兔写文献,引导新飞行,
cargo安装易,性能分析兴。
Xcode工具妙,优化共振灵,
开发如书写,码海创新吟。
🌟✨🐇💻


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Outside diff range and nitpick comments (3)
CONTRIBUTING.md (3)

Line range hint 166-171: 在 Umi 或 Bigfish 中使用 Xcode 工具进行性能分析

提到了在 Umi 或 Bigfish 项目中使用 Xcode 工具进行性能分析,但没有提供具体的分析步骤或示例。这可能会让初学者感到困惑。

如果需要,我可以帮助补充具体的性能分析步骤或示例。

Tools
Markdownlint

168-168: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


169-169: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


Line range hint 129-129: 修正拼写错误

文档中的 "xcode dev tool" 应该是 "Xcode dev tool"。

- xcode dev tool
+ Xcode dev tool
Tools
Markdownlint

9-9: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


14-14: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)


Line range hint 193-193: 避免使用裸露的 URL

文档中直接使用了裸露的 URL,建议使用描述性文本来替代 URL,以提高文档的可读性和专业性。

- Refer to https://yuque.antfin.com/mako/vz2gn4/vkp4qs8u4zcuxqoc for details.
+ Refer to [Mako Release Details](https://yuque.antfin.com/mako/vz2gn4/vkp4qs8u4zcuxqoc) for more information.
Tools
Markdownlint

9-9: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


14-14: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 919597b and d5bc58f.

Files selected for processing (1)
  • CONTRIBUTING.md (2 hunks)
Additional context used
LanguageTool
CONTRIBUTING.md

[misspelling] ~129-~129: 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

8-8: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


9-9: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


21-21: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


22-22: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


28-28: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


29-29: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


35-35: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


75-75: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


76-76: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


82-82: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


88-88: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


94-94: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


95-95: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


96-96: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


123-123: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


124-124: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


132-132: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


147-147: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


153-153: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


159-159: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


160-160: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


161-161: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


162-162: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


168-168: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


169-169: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


170-170: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


171-171: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


193-193: null
Bare URL used

(MD034, no-bare-urls)


14-14: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

Comment on lines +12 to +17
Install `cargo`.

```
curl https://sh.rustup.rs -sSf | sh
```

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

添加 Cargo 的安装说明

建议为安装命令提供更多背景信息,例如为什么选择这种安装方式,以及安装后的下一步操作是什么。

如果需要,我可以帮助补充相关的背景信息和后续步骤。

Tools
Markdownlint

14-14: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

@@ -9,6 +9,12 @@ $ git clone git@github.com:umijs/mako.git
$ cd mako
```

Install `cargo`.

```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

指定代码块的语言

在安装 Cargo 的代码块中没有指定语言,这可能会影响 Markdown 渲染的效果。

- ```
+ ```bash
Tools
Markdownlint

14-14: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

@sorrycc
Copy link
Member

sorrycc commented Jun 30, 2024

感谢 PR。感觉在 #1339 里的 Install Rust 里已覆盖,先 Close 。

@sorrycc sorrycc closed this Jun 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants