chore: highlight our committers in CONTRIBUTING.md #4189
Conversation
Signed-off-by: tison <[email protected]>
WalkthroughThe changes introduced to Changes
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 (
|
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (3)
CONTRIBUTING.md (3)
Line range hint
58-62: Clarify Community Engagement Instructions.The instructions for community engagement are clear, but the repetitive use of "Make sure" at the beginning of several sentences could be rephrased for better readability and variety in language.
- Make sure all files have proper license header. - Make sure all your codes are formatted. - Make sure all unit tests are passed. + Ensure all files have proper license headers. + Ensure your code is properly formatted. + Ensure all unit tests pass.Tools
LanguageTool
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...
[style] ~12-~12: ‘with respect to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)
Context: ...y can help you get started. Communicate with respect to developers maintaining and developing t...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Line range hint
66-66: Correct the verb form in thepre-commitsection.The verb "setup" is used as a noun; it should be "set up" when used as a verb.
- You could setup the [`pre-commit`](https://pre-commit.com/#plugins) hooks... + You could set up the [`pre-commit`](https://pre-commit.com/#plugins) hooks...Tools
LanguageTool
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...
[style] ~12-~12: ‘with respect to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)
Context: ...y can help you get started. Communicate with respect to developers maintaining and developing t...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Line range hint
96-98: Encourage Conciseness in PR Descriptions.While encouraging brief descriptions for small PRs is good, ensure that the language used promotes professionalism and clarity. Consider rephrasing "feel free to go brief" to avoid informal tone.
- Feel free to go brief if your pull request is small... + You may keep your description brief for smaller pull requests...Tools
LanguageTool
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...
[style] ~12-~12: ‘with respect to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)
Context: ...y can help you get started. Communicate with respect to developers maintaining and developing t...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CONTRIBUTING.md (1 hunks)
Additional context used
LanguageTool
CONTRIBUTING.md
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...
[style] ~12-~12: ‘with respect to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)
Context: ...y can help you get started. Communicate with respect to developers maintaining and developing t...
[style] ~32-~32: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB)
Context: ...r experience with GreptimeDB, or if you want to discuss any ideas, you can start a disc...
[uncategorized] ~58-~58: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...power. ### Before PR - To ensure that community is free and confident in its ability to...
[style] ~61-~61: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...d style guide. - Make sure all unit tests are passed (using `...
[style] ~62-~62: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ....st/index.html)cargo nextest run). - Make sure all clippy warnings are fixed (you...
[grammar] ~66-~66: The word “setup” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...). ####pre-commitHooks You could setup the [pre-commit`](https://pre-commit.c...
[style] ~96-~96: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional. (FEEL_FREE_TO_STYLE_ME)
Context: ...pull request title. ### Description - Feel free to go brief if your pull request is small,...
Markdownlint
CONTRIBUTING.md
20-20: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
21-21: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
22-22: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
23-23: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
24-24: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
28-28: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
29-29: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
30-30: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
31-31: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
32-32: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
46-46: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
47-47: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
48-48: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
49-49: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
50-50: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
51-51: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
52-52: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
53-53: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
54-54: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
58-58: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
59-59: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
60-60: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
61-61: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
62-62: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
96-96: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
97-97: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
98-98: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
113-113: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
114-114: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
118-118: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
119-119: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
120-120: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
5-5: null (MD034, no-bare-urls)
Bare URL used
28-28: null (MD034, no-bare-urls)
Bare URL used
Additional comments not posted (1)
CONTRIBUTING.md (1)
5-11: Highlight the committers effectively and ensure URL correctness.The addition of a section recognizing the contributions of specific committers and outlining their roles is a positive change, fostering a sense of community and acknowledgment. However, ensure that the URL used in line 5 is correctly formatted to prevent accessibility issues.
Verification successful
URL verification successful for the contributors' link.
The URL
https://github.com/GreptimeTeam/greptimedb/graphs/contributorsis correctly formatted and accessible.
- No further action is required for the URL.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the URL format and accessibility. # Test: Check if the URL is correctly formatted and accessible. curl -I https://github.com/GreptimeTeam/greptimedb/graphs/contributorsLength of output: 4571
Tools
LanguageTool
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (5)
CONTRIBUTING.md (5)
Line range hint
1-1: Formalize the GreetingThe expression "Thanks a lot" might be perceived as too informal for a contributing guide. Consider adopting a more formal tone to maintain professionalism across the document.
- Thanks a lot for considering contributing to GreptimeDB. + Thank you for considering contributing to GreptimeDB.Tools
LanguageTool
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Line range hint
32-32: Avoid Repetition of PhrasesConsider rephrasing to avoid the repetitive use of "want to" in close proximity, enhancing the readability of the document.
- or if you want to discuss any ideas, you can start a discussion + or if you wish to discuss any ideas, you can start a discussionTools
LanguageTool
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Line range hint
61-62: Avoid Repetitive Sentence BeginningsThe consecutive sentences starting with "Make sure" can be rephrased for variety and better flow.
- Make sure all unit tests are passed + Ensure all unit tests pass - Make sure all clippy warnings are fixed + Address all clippy warningsTools
LanguageTool
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Line range hint
66-66: Correct Verb FormThe word "setup" is incorrectly used as a verb. It should be "set up" when used in this context.
- You could setup the [`pre-commit`](https://pre-commit.com/#plugins) hooks + You could set up the [`pre-commit`](https://pre-commit.com/#plugins) hooksTools
LanguageTool
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Line range hint
96-96: Reduce Overused PhrasesThe phrase "feel free to" is commonly overused. Consider using a less frequent alternative to enhance the professionalism of the text.
- Feel free to go brief if your pull request is small + You may be brief if your pull request is smallTools
LanguageTool
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CONTRIBUTING.md (1 hunks)
Additional context used
LanguageTool
CONTRIBUTING.md
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...
[style] ~32-~32: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB)
Context: ...r experience with GreptimeDB, or if you want to discuss any ideas, you can start a disc...
[style] ~61-~61: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...d style guide. - Make sure all unit tests are passed (using `...
[style] ~62-~62: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ....st/index.html)cargo nextest run). - Make sure all clippy warnings are fixed (you...
[grammar] ~66-~66: The word “setup” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...). ####pre-commitHooks You could setup the [pre-commit`](https://pre-commit.c...
[style] ~96-~96: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional. (FEEL_FREE_TO_STYLE_ME)
Context: ...pull request title. ### Description - Feel free to go brief if your pull request is small,...
Markdownlint
CONTRIBUTING.md
20-20: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
21-21: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
22-22: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
23-23: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
24-24: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
28-28: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
29-29: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
30-30: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
31-31: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
32-32: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
46-46: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
47-47: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
48-48: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
49-49: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
50-50: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
51-51: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
52-52: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
53-53: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
54-54: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
58-58: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
59-59: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
60-60: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
61-61: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
62-62: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
96-96: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
97-97: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
98-98: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
113-113: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
114-114: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
118-118: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
119-119: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
120-120: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
5-5: null (MD034, no-bare-urls)
Bare URL used
28-28: null (MD034, no-bare-urls)
Bare URL used
Additional comments not posted (1)
CONTRIBUTING.md (1)
5-11: Highlight Committers SectionThe addition of the committers' section with their roles and contributions is well-executed. It provides visibility and recognition to key contributors, which is aligned with the PR's objectives. This change is both informative and motivational for the community.
Tools
LanguageTool
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...meDB for a few months and keep bringing high quality contributions (code, docs, advocate, et...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: tison <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (2)
CONTRIBUTING.md (2)
Line range hint
66-66: Correct verb usage in technical documentation.The word "setup" is a noun, and the verb should be "set up".
- You could setup the [`pre-commit`](https://pre-commit.com/#plugins) hooks to run these checks on every commit automatically. + You could set up the [`pre-commit`](https://pre-commit.com/#plugins) hooks to run these checks on every commit automatically.Tools
LanguageTool
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Line range hint
96-96: Avoid overused phrases to maintain a professional tone.The phrase "feel free to" is frequently used and can be replaced with a more formal alternative to enhance the tone of the document.
- Feel free to go brief if your pull request is small, like a typo fix. + You may provide a brief description for smaller pull requests, such as typo corrections.Tools
LanguageTool
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...Markdownlint
5-5: null (MD034, no-bare-urls)
Bare URL used
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CONTRIBUTING.md (1 hunks)
Additional context used
LanguageTool
CONTRIBUTING.md
[style] ~2-~2: ‘Thanks a lot’ is a rather informal expression of gratitude. Consider replacing it to add a more respectful tone to your message. (THANKS_A_LOT)
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...
[style] ~32-~32: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB)
Context: ...r experience with GreptimeDB, or if you want to discuss any ideas, you can start a disc...
[style] ~61-~61: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...d style guide. - Make sure all unit tests are passed (using `...
[style] ~62-~62: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ....st/index.html)cargo nextest run). - Make sure all clippy warnings are fixed (you...
[grammar] ~66-~66: The word “setup” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...). ####pre-commitHooks You could setup the [pre-commit`](https://pre-commit.c...
[style] ~96-~96: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional. (FEEL_FREE_TO_STYLE_ME)
Context: ...pull request title. ### Description - Feel free to go brief if your pull request is small,...
Markdownlint
CONTRIBUTING.md
20-20: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
21-21: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
22-22: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
23-23: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
24-24: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
28-28: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
29-29: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
30-30: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
31-31: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
32-32: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
46-46: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
47-47: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
48-48: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
49-49: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
50-50: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
51-51: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
52-52: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
53-53: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
54-54: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
58-58: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
59-59: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
60-60: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
61-61: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
62-62: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
96-96: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
97-97: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
98-98: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
113-113: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
114-114: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
118-118: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
119-119: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
120-120: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
5-5: null (MD034, no-bare-urls)
Bare URL used
28-28: null (MD034, no-bare-urls)
Bare URL used
Additional comments not posted (2)
CONTRIBUTING.md (2)
7-11: New section about committers is informative and well-structured.The addition of committers along with their roles and contributions enhances transparency and recognition within the community.
12-12: Simplify and clarify communication guidelines.The phrase "Communicate respectfully with the developers maintaining and developing the project" could be streamlined for better clarity and brevity. This suggestion aligns with the previous comment made on this section and the hint from LanguageTool.
- Communicate respectfully with the developers maintaining and developing the project. + Respectfully communicate with the project's developers.[REFACTOR_Suggestion]
I hereby agree to the terms of the GreptimeDB CLA.
Refer to a related PR or issue link (optional)
What's changed and what's your intention?
Of course we should do this. Let's see if we can show this information in our website or contribution guide docs page.
Kudos to @etolbakov and @NiwakaDev!
Checklist
Summary by CodeRabbit
CONTRIBUTING.mdto include detailed information about contributors and committers, including their roles, links to profiles, and specified privileges.