chore: add AUTHOR.md file #4241
Conversation
Signed-off-by: tison <wander4096@gmail.com>
WalkthroughThe changes involve three key files in the GreptimeDB repository: 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: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- AUTHOR.md (1 hunks)
- CONTRIBUTING.md (1 hunks)
- README.md (1 hunks)
Files skipped from review due to trivial changes (1)
- AUTHOR.md
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.
Context: # Welcome 👋 Thanks a lot for considering contributing to Greptim...(THANKS_A_LOT)
[style] ~29-~29: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...r experience with GreptimeDB, or if you want to discuss any ideas, you can start a disc...(REP_WANT_TO_VB)
[uncategorized] ~55-~55: Possible missing article found.
Context: ...power. ### Before PR - To ensure that community is free and confident in its ability to...(AI_HYDRA_LEO_MISSING_THE)
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d style guide. - Make sure all unit tests are passed (using `...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....st/index.html)cargo nextest run). - Make sure all clippy warnings are fixed (you...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~63-~63: The word “setup” is a noun. The verb is spelled with a space.
Context: ...). ####pre-commitHooks You could setup the [pre-commit`](https://pre-commit.c...(NOUN_VERB_CONFUSION)
[style] ~93-~93: 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.
Context: ...pull request title. ### Description - Feel free to go brief if your pull request is small,...(FEEL_FREE_TO_STYLE_ME)
[uncategorized] ~94-~94: Possible missing article found.
Context: ..., like a typo fix. - But if it contains large code change, make sure to state the mot...(AI_HYDRA_LEO_MISSING_A)
Markdownlint
CONTRIBUTING.md
5-5: null
Bare URL used(MD034, no-bare-urls)
25-25: null
Bare URL used(MD034, no-bare-urls)
README.md
137-137: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
141-141: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
142-142: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
143-143: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
144-144: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
145-145: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
146-146: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
165-165: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
166-166: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
167-167: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
171-171: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
172-172: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
173-173: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
188-188: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
189-189: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
190-190: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
191-191: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
192-192: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
Additional comments not posted (3)
CONTRIBUTING.md (2)
7-7: Use a more formal expression of gratitude.The phrase "Thanks a lot" is informal. Consider replacing it with "Thank you very much" to maintain a respectful tone.
- Thanks a lot for considering contributing to GreptimeDB. + Thank you very much for considering contributing to GreptimeDB.
7-7: Verify the link toAUTHOR.md.Ensure that the
AUTHOR.mdfile exists in the repository and the link is correct.Verification successful
The link to
AUTHOR.mdinCONTRIBUTING.mdis correct.
- The
AUTHOR.mdfile exists in the repository root.- The link syntax in
CONTRIBUTING.mdcorrectly points toAUTHOR.md.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of the AUTHOR.md file. # Test: Check if the AUTHOR.md file exists in the repository root. if [ ! -f "AUTHOR.md" ]; then echo "AUTHOR.md file is missing." exit 1 fi echo "AUTHOR.md file exists."Length of output: 81
Script:
#!/bin/bash # Description: Verify the correctness of the link to AUTHOR.md in CONTRIBUTING.md # Test: Check if the link syntax in CONTRIBUTING.md correctly points to AUTHOR.md # Use grep to find the link syntax in CONTRIBUTING.md grep -q "\[AUTHOR.md\](AUTHOR.md)" CONTRIBUTING.md if [ $? -ne 0 ]; then echo "The link to AUTHOR.md in CONTRIBUTING.md is incorrect." exit 1 fi echo "The link to AUTHOR.md in CONTRIBUTING.md is correct."Length of output: 185
README.md (1)
186-186: Verify the link toAUTHOR.md.Ensure that the
AUTHOR.mdfile exists in the repository and the link is correct.Verification successful
The
AUTHOR.mdfile exists, and the link in the README.md is correct.
- The link to
AUTHOR.mdin the README.md file is valid.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of the AUTHOR.md file. # Test: Check if the AUTHOR.md file exists in the repository root. if [ ! -f "AUTHOR.md" ]; then echo "AUTHOR.md file is missing." exit 1 fi echo "AUTHOR.md file exists."Length of output: 81
Signed-off-by: tison <wander4096@gmail.com>
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?
AS IS
Checklist
Summary by CodeRabbit
AUTHOR.mdwith a list of individual committers and their GitHub profiles.CONTRIBUTING.mdto reference theAUTHOR.mdfile for the list of current committers.README.md, with a link toAUTHOR.md.