[ISSUE #2446]📝Add Contributor Guide doc #2447
Conversation
WalkthroughThis pull request introduces a comprehensive contributor guide for the RocketMQ Rust project. The changes include updating the Jekyll configuration file with a new theme skin and masthead title, modifying the navigation structure, and adding a new markdown file with detailed contribution guidelines. The new documentation provides step-by-step instructions for potential contributors on how to report issues, prepare the repository, select tasks, create branches, write code, and submit pull requests. Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
🔊@mxsm 🚀Thanks for your contribution🎉！ 💡CodeRabbit(AI) will review your code first🔥！ Note 🚨The code review suggestions from CodeRabbit are to be used as a reference only, and the PR submitter can decide whether to make changes based on their own judgment. Ultimately, the project management personnel will conduct the final code review💥. |
rocketmq-rust-bot
added
AI review first
rocketmq-rust-bot
requested review from
rocketmq-rust-bot,
SpaceXCN and
TeslaRustor
rocketmq-rust-robot
added
the
documentation📝
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2447 +/- ##
=======================================
Coverage 28.64% 28.64%
=======================================
Files 510 510
Lines 73491 73491
=======================================
Hits 21048 21048
Misses 52443 52443 ☔ View full report in Codecov by Sentry. |
![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
🧹 Nitpick comments (1)
rocketmq-doc/_docs/19-contribute-guide.md (1)
15-21: Enhance issue reporting guidelinesConsider adding these important guidelines for issue reporting:
- Version information requirement
- Steps to reproduce
- Expected vs actual behavior
- System environment details
🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: The preposition ‘to’ seems more likely in this position.
Context: ...to the template. - Please pay attention for your issue, you may need provide more i...(AI_HYDRA_LEO_REPLACE_FOR_TO)
[grammar] ~21-~21: The verb “provide” needs to be in the to-infinitive form.
Context: ...e pay attention for your issue, you may need provide more information during discussion. ##...(MISSING_TO_BEFORE_A_VERB)
[style] ~21-~21: Consider using a more formal alternative.
Context: ...on for your issue, you may need provide more information during discussion. ## How to Contribut...(MORE_INFO)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
rocketmq-doc/_config.yml(2 hunks)rocketmq-doc/_data/navigation.yml(1 hunks)rocketmq-doc/_docs/19-contribute-guide.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- rocketmq-doc/_data/navigation.yml
🧰 Additional context used
🪛 LanguageTool
rocketmq-doc/_docs/19-contribute-guide.md
[uncategorized] ~21-~21: The preposition ‘to’ seems more likely in this position.
Context: ...to the template. - Please pay attention for your issue, you may need provide more i...
(AI_HYDRA_LEO_REPLACE_FOR_TO)
[grammar] ~21-~21: The verb “provide” needs to be in the to-infinitive form.
Context: ...e pay attention for your issue, you may need provide more information during discussion. ##...
(MISSING_TO_BEFORE_A_VERB)
[style] ~21-~21: Consider using a more formal alternative.
Context: ...on for your issue, you may need provide more information during discussion. ## How to Contribut...
(MORE_INFO)
[uncategorized] ~65-~65: Possible missing preposition found.
Context: ...ilation, and format checking. Format the code in the project ```shell cargo f...
(AI_HYDRA_LEO_MISSING_OF)
[misspelling] ~104-~104: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...gh. - At last, congratulations on being an contributor of rocketmq-rust Note:...
(EN_A_VS_AN)
🪛 markdownlint-cli2 (0.17.2)
rocketmq-doc/_docs/19-contribute-guide.md
25-25: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
38-38: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
39-39: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
40-40: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
41-41: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
52-52: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
53-53: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
54-54: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
55-55: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
65-65: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
71-71: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
77-77: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
79-79: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
86-86: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
90-90: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
92-92: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
98-98: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: build (windows-latest, nightly)
- GitHub Check: build (windows-latest, stable)
- GitHub Check: build (macos-latest, nightly)
- GitHub Check: build (macos-latest, stable)
- GitHub Check: test
- GitHub Check: build (ubuntu-latest, nightly)
- GitHub Check: auto-approve
- GitHub Check: build
- GitHub Check: build (ubuntu-latest, stable)
🔇 Additional comments (2)
rocketmq-doc/_docs/19-contribute-guide.md (1)
5-5: Update the last_modified_at dateThe last_modified_at date is set to 2025, which is in the future. This could cause issues with Jekyll's date-based features.
Please update it to the current date.
rocketmq-doc/_config.yml (1)
10-10: LGTM! Theme and masthead title updates look goodThe changes improve the site's visual appearance and branding:
- Updated theme to "sunrise" for better readability
- Added "RocketMQ-Rust" as the masthead title
Also applies to: 24-24
| ``` | ||
| cargo clippy --all-targets --all-features --workspace | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add language specifiers to code blocks
Code blocks are missing language specifiers, which affects syntax highlighting.
Add shell to the following code blocks:
-```
+```shell
cargo clippy --all-targets --all-features --workspace- +shell
cargo test --all-features --workspace
-```
+```shell
git add modified-file-names
git commit -m 'commit log'
git push origin feature-issueNo(custom)
Also applies to: 86-88, 92-96
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
79-79: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
|
|
||
| ## How to Contribute | ||
|
|
||
| #### 1. Prepare repository |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix heading hierarchy
The document uses h4 headings (####) directly under h2 (##). This breaks the heading hierarchy.
Change the following headings from h4 to h3:
-#### 1. Prepare repository
+### 1. Prepare repository
-#### 2. Choose Issue
+### 2. Choose Issue
-#### 3. Create Branch
+### 3. Create Branch
-#### 4. Coding
+### 4. CodingAlso applies to: 44-44, 49-49, 61-61
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
25-25: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
| well enough. | ||
| - At last, congratulations on being an contributor of rocketmq-rust | ||
|
|
||
| **Note:** 🚨TThe code review suggestions from CodeRabbit are to be used as a reference only, and the PR submitter can |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix typo in the note section
There's a typo in the word "The" (written as "TThe").
-**Note:** 🚨TThe code review suggestions
+**Note:** 🚨The code review suggestions📝 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.
| **Note:** 🚨TThe code review suggestions from CodeRabbit are to be used as a reference only, and the PR submitter can | |
| **Note:** 🚨The code review suggestions from CodeRabbit are to be used as a reference only, and the PR submitter can |
| ```bash | ||
| https://github.com/(github name)/rocketmq-rust.git | ||
| ``` |
There was a problem hiding this comment.
Fix the git clone command
The git clone command is incomplete and missing the git clone prefix.
-https://github.com/(github name)/rocketmq-rust.git
+git clone https://github.com/<your-github-username>/rocketmq-rust.git| - Create a new issue and choose the type of issue. | ||
| - Define the issue with a clear and descriptive title. | ||
| - Fill in necessary information according to the template. | ||
| - Please pay attention for your issue, you may need provide more information during discussion. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix grammar in the sentence
The sentence has grammatical issues:
- Replace "for" with "to"
- Add "to" before "provide"
-Please pay attention for your issue, you may need provide more information during discussion.
+Please pay attention to your issue, you may need to provide more information during discussion.📝 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.
| - Please pay attention for your issue, you may need provide more information during discussion. | |
| Please pay attention to your issue, you may need to provide more information during discussion. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: The preposition ‘to’ seems more likely in this position.
Context: ...to the template. - Please pay attention for your issue, you may need provide more i...
(AI_HYDRA_LEO_REPLACE_FOR_TO)
[grammar] ~21-~21: The verb “provide” needs to be in the to-infinitive form.
Context: ...e pay attention for your issue, you may need provide more information during discussion. ##...
(MISSING_TO_BEFORE_A_VERB)
[style] ~21-~21: Consider using a more formal alternative.
Context: ...on for your issue, you may need provide more information during discussion. ## How to Contribut...
(MORE_INFO)
rocketmq-rust-bot
added
approved
Which Issue(s) This PR Fixes(Closes)
Fixes #2446
Brief Description
How Did You Test This Change?
Summary by CodeRabbit
Documentation
New Features