docs: opt contributiong.md #1339
Conversation
Walkthrough本次变更对 Changes
Poem
Tip Early access features: enabledWe are currently testing the following features in early access:
Note:
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: 5
Outside diff range and nitpick comments (2)
CONTRIBUTING.md (2)
Line range hint
131-131: 拼写错误：将 "Mac AppStore" 更改为 "Mac App Store"可能存在拼写错误。
- Install Xcode App from Mac AppStore and switch xcode dev tool with: + Install Xcode App from Mac App Store and switch xcode dev tool with:Tools
LanguageTool
[style] ~6-~6: Often, this adverbial phrase is redundant. Consider using an alternative.
Context: ...g ## Getting Started ### Environment First of all, you need to install the following tool...(FIRST_OF_ALL)
Markdownlint
16-16: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
17-17: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
23-23: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
24-24: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
30-30: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
Line range hint
134-134: 建议：移除命令前的美元符号根据Markdownlint的建议，命令前不应使用美元符号。
- $ sudo xcode-select -s /Applications/Xcode.app/Contents/Developer - $ cargo install cargo-instruments - # see instruments template: - $ cargo instruments --list-templates - $ cargo instruments -t sys --profile release-debug --package mako --bin mako examples/with-antd - $ open target/instruments/mako_System-Trace_xxx.trace - $ OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js umi build - $ OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js umi dev - $ OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js max build - $ OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js bigfish build - $ XCODE_PROFILE=1 OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js umi build - $ XCODE_PROFILE=1 OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js umi dev - $ XCODE_PROFILE=1 OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js max build - $ XCODE_PROFILE=1 OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js bigfish build + sudo xcode-select -s /Applications/Xcode.app/Contents/Developer + cargo install cargo-instruments + # see instruments template: + cargo instruments --list-templates + cargo instruments -t sys --profile release-debug --package mako --bin mako examples/with-antd + open target/instruments/mako_System-Trace_xxx.trace + OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js umi build + OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js umi dev + OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js max build + OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js bigfish build + XCODE_PROFILE=1 OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js umi build + XCODE_PROFILE=1 OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js umi dev + XCODE_PROFILE=1 OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js max build + XCODE_PROFILE=1 OKAM=/PATH/TO/umijs/marko/packages/bundler-mako/index.js bigfish buildAlso applies to: 149-149, 155-155, 161-161, 162-162, 163-163, 164-164, 169-169, 170-170, 171-171, 172-172
Tools
LanguageTool
[style] ~6-~6: Often, this adverbial phrase is redundant. Consider using an alternative.
Context: ...g ## Getting Started ### Environment First of all, you need to install the following tool...(FIRST_OF_ALL)
Markdownlint
16-16: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
17-17: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
23-23: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
24-24: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
30-30: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CONTRIBUTING.md (4 hunks)
Additional context used
LanguageTool
CONTRIBUTING.md
[style] ~6-~6: Often, this adverbial phrase is redundant. Consider using an alternative.
Context: ...g ## Getting Started ### Environment First of all, you need to install the following tool...(FIRST_OF_ALL)
[style] ~80-~80: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...en target/llvm-cov/html/index.htmlRun fmt to format code.bash $ just fmt...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~86-~86: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...o format code.bash $ just fmtRun lint to check code style. ```bash $ ju...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~131-~131: 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
16-16: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
17-17: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
23-23: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
24-24: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
30-30: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
31-31: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
37-37: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
77-77: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
78-78: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
84-84: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
90-90: 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)
97-97: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
98-98: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
125-125: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
126-126: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
134-134: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
149-149: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
155-155: 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)
163-163: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
164-164: 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)
172-172: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
168-168: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
194-194: null
Bare URL used(MD034, no-bare-urls)
| @@ -63,26 +71,26 @@ $ cargo nextest run transformers::transform_try_resolve::tests | |||
| $ cargo insta review | |||
| ``` | |||
|
|
|||
| Coverage. | |||
| Run Coverage. | |||
|
|
|||
| ```bash | |||
| $ cargo codecov | |||
| $ cargo codecov --html && open target/llvm-cov/html/index.html | |||
| ``` | |||
|
|
|||
There was a problem hiding this comment.
建议：重新措辞以避免重复的句子开头
连续三个句子以相同的词开头，建议重新措辞或使用同义词。
- Run fmt to format code.
- Run lint to check code style.
+ Use `just fmt` to format the code.
+ Use `just lint` to check the code style.Also applies to: 86-86
Tools
LanguageTool
[style] ~80-~80: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...en target/llvm-cov/html/index.htmlRun fmt to format code.bash $ just fmt...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
| $ git clone git@github.com:umijs/mako.git | ||
| $ cd mako | ||
| ``` | ||
|
|
||
| Install tools. | ||
| Install dependencies. | ||
|
|
||
| ```bash | ||
| $ cargo install just | ||
| $ cargo install cargo-binstall |
There was a problem hiding this comment.
建议：移除命令前的美元符号
根据Markdownlint的建议，命令前不应使用美元符号。
- $ git clone git@github.com:umijs/mako.git
- $ cd mako
- $ cargo install just
- $ cargo install cargo-binstall
- $ cargo build
- $ cargo build --release
- $ pnpm build
+ git clone git@github.com:umijs/mako.git
+ cd mako
+ cargo install just
+ cargo install cargo-binstall
+ cargo build
+ cargo build --release
+ pnpm buildAlso applies to: 30-31, 37-37
Tools
Markdownlint
16-16: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
17-17: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
23-23: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
24-24: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
| @@ -44,15 +52,15 @@ $ RUST_LOG=mako::parse=debug,info cargo run --bin mako examples/normal | |||
|
|
|||
| ## Advanced Tasks | |||
|
|
|||
| Before you push. | |||
| Before you push your code, you should run the following commands to make sure everything is ok. | |||
There was a problem hiding this comment.
建议：移除命令前的美元符号
根据Markdownlint的建议，命令前不应使用美元符号。
- $ just ready
- # without e2e
- $ just ready-lite
- $ pnpm playwright install # only need to run before the first time you run "jest test"
- $ just test
- # test specified testcase
- $ cargo nextest run transformers::transform_try_resolve::tests
- # review snapshot
- $ cargo insta review
- $ cargo codecov
- $ cargo codecov --html && open target/llvm-cov/html/index.html
- $ just fmt
- $ just lint
- $ cargo upgrade
- $ cargo upgrade --incompatible
- $ cargo upgrade --dry-run
+ just ready
+ # without e2e
+ just ready-lite
+ pnpm playwright install # only need to run before the first time you run "jest test"
+ just test
+ # test specified testcase
+ cargo nextest run transformers::transform_try_resolve::tests
+ # review snapshot
+ cargo insta review
+ cargo codecov
+ cargo codecov --html && open target/llvm-cov/html/index.html
+ just fmt
+ just lint
+ cargo upgrade
+ cargo upgrade --incompatible
+ cargo upgrade --dry-runAlso applies to: 63-63, 74-74, 81-81, 87-87, 93-93
| @@ -2,21 +2,29 @@ | |||
|
|
|||
| ## Getting Started | |||
|
|
|||
| Clone. | |||
| ### Environment | |||
|
|
|||
There was a problem hiding this comment.
建议：移除冗余短语 "First of all"
这个副词短语通常是多余的，可以考虑使用替代表达方式。
- First of all, you need to install the following tools:
+ You need to install the following tools:Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| You need to install the following tools: |
Tools
LanguageTool
[style] ~6-~6: Often, this adverbial phrase is redundant. Consider using an alternative.
Context: ...g ## Getting Started ### Environment First of all, you need to install the following tool...(FIRST_OF_ALL)
| @@ -29,7 +37,7 @@ Build js packages (include packages/mako). | |||
| $ pnpm build | |||
| ``` | |||
|
|
|||
| Run. | |||
| Run mako with examples. | |||
There was a problem hiding this comment.
建议：移除命令前的美元符号
根据Markdownlint的建议，命令前不应使用美元符号。
- $ cargo run --bin mako examples/normal
- # with HMR
- $ cargo run --bin mako examples/normal --watch
- # in production
- $ cargo run --bin mako examples/normal --mode production
- # filter logs
- $ RUST_LOG=mako=debug,info cargo run --bin mako examples/normal
- $ RUST_LOG=mako::parse=debug,info cargo run --bin mako examples/normal
+ cargo run --bin mako examples/normal
+ # with HMR
+ cargo run --bin mako examples/normal --watch
+ # in production
+ cargo run --bin mako examples/normal --mode production
+ # filter logs
+ RUST_LOG=mako=debug,info cargo run --bin mako examples/normal
+ RUST_LOG=mako::parse=debug,info cargo run --bin mako examples/normalCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Run mako with examples. | |
| Run mako with examples. | |
| cargo run --bin mako examples/normal | |
| # with HMR | |
| cargo run --bin mako examples/normal --watch | |
| # in production | |
| cargo run --bin mako examples/normal --mode production | |
| # filter logs | |
| RUST_LOG=mako=debug,info cargo run --bin mako examples/normal | |
| RUST_LOG=mako::parse=debug,info cargo run --bin mako examples/normal |
|
根据 CR 建议改改？ |
文案描述可以调整， |
Summary by CodeRabbit