Updating CONTRIBUTING guidelines and trimmed README #1646
Conversation
WalkthroughThis pull request updates contributor documentation by restructuring and simplifying guidelines across multiple files. The main Changes
Poem
🪧 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
CodeRabbit Configuration 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
🧹 Nitpick comments (11)
CONTRIBUTING/git.md (3)
5-16: Consider using a language specifier for code blocks.
The first code block (lines 5–16) is marked with “text”. Using “bash” instead would enable proper syntax highlighting for shell commands.Suggested diff:
-```text +$ bash
27-33: Enhance code block language clarity.
Similarly, the code block containing the commit and push commands (lines 27–33) would benefit from using “bash” rather than “text” for consistency and clarity.Suggested diff:
-```text +```bash
38-49: Rebase instructions are clear but consider a minor language tweak.
It might be clearer to say “rebase your branch onto master” rather than “pull rebase your change.” Additionally, using “bash” for the code block instead of “text” is recommended.Suggested diff:
-```text +```bashCONTRIBUTING/development-setup.md (5)
21-24: Clarify the explanation for running the binary.
The current text on lines 21–24 has a punctuation issue and could be rephrased for clarity. For example, it’s better to avoid the awkward “server., or,” phrasing.Suggested diff:
-The above command will create a binary `dicedb`. Execute the binary and that will -start the DiceDB server., or, you can run the following command to run like a usual -Go program +The above command will create a binary `dicedb`. Execute the binary to start the DiceDB server, +or run the following command to execute it as a typical Go program.
39-41: Refine CLI instructions.
On lines 39–41, consider rephrasing for smoother reading. For example, “Execute the binary to launch the CLI, which will attempt to connect to the DiceDB server.” would be clearer.Suggested diff:
-The above command will create a binary `dicedb-cli`. Execute the binary will -start the CLI and will try to connect to the DiceDB server. +The above command creates a binary `dicedb-cli`. Execute it to launch the CLI, which will attempt to connect to the DiceDB server.
74-75: Minor grammatical improvement.
On line 74, add an article for clarity. Consider changing “This will generate configuration file (dicedb.yaml) in metadata directory.” to “This will generate a configuration file (dicedb.yaml) in the metadata directory.”Proposed diff:
-This will generate configuration file (`dicedb.yaml`) in metadata directory. +This will generate a configuration file (`dicedb.yaml`) in the metadata directory.🧰 Tools
🪛 LanguageTool
[uncategorized] ~74-~74: Possible missing article found.
Context: ....go config-init ``` This will generate configuration file (dicedb.yaml) in metadata direct...(AI_HYDRA_LEO_MISSING_A)
80-81: Improve conditional phrasing for directory selection.
The sentence on lines 80–81 could be refined for clarity. A revised version might be: “If you run withsudoprivileges, these directories will be used; otherwise, the current working directory will be used as the metadata directory.”Suggested diff:
-If you run with a `sudo` privileges, then these directories are used, otherwise -the current working directory is used as the metadata directory. +If you run with `sudo` privileges, these directories will be used; otherwise, +the current working directory will serve as the metadata directory.🧰 Tools
🪛 LanguageTool
[typographical] ~80-~80: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... privileges, then these directories are used, otherwise the current working directory is used a...(THUS_SENTENCE)
106-107: Punctuation improvement for clarity.
On line 107, add a comma after “By default” for natural reading: “By default, it connects to the local instance...”Suggested diff:
-By default it connects to the local instance of DiceDB running on port `7379`. +By default, it connects to the local instance of DiceDB running on port `7379`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~106-~106: Did you mean: “By default,”?
Context: ... before you run the following commands. By default it connects to the local instance of Di...(BY_DEFAULT_COMMA)
CONTRIBUTING/README.md (1)
42-47: Overall, the revised CONTRIBUTING/README.md successfully condenses details while still pointing to the detailed guides.
Minor stylistic improvement at line 5: Consider rephrasing “So, as per your interest, you can pick one and build a deeper understanding of the project on the go.” For example, “Choose a repository that aligns with your interests to gain a deeper understanding of the project.”README.md (2)
27-28: Update phrasing for setting up from source.
The new note (lines 27–28) clearly directs users to the development setup guide. However, the verb “setup” should be split into “set up” when used as an action.Suggested diff:
-> > If you are looking to setup DiceDB for development or want to setup from source, refer -> > our [CONTRIBUTING/development-setup.md](https://github.com/DiceDB/dice/blob/master/CONTRIBUTING/development-setup.md) guide. +> If you are looking to set up DiceDB for development or want to set up from source, refer +> to our [CONTRIBUTING/development-setup.md](https://github.com/DiceDB/dice/blob/master/CONTRIBUTING/development-setup.md) guide.🧰 Tools
🪛 LanguageTool
[grammar] ~27-~27: The word “setup” is a noun. The verb is spelled with a space.
Context: ...setup DiceDB for development or want to setup from source, refer > our [CONTRIBUTING/...(NOUN_VERB_CONFUSION)
47-49: "Support and Sponsor Us" heading and content are clear.
The updated heading emphasizes community support. If your style guidelines prefer a specific heading style (setext vs. atx), consider making it consistent throughout the document.🧰 Tools
🪛 LanguageTool
[style] ~49-~49: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...nd Sponsor Us DiceDB is a project with a very strong vision and [roadmap](https://dicedb.io/...(EN_WEAK_ADJECTIVE)
🪛 markdownlint-cli2 (0.17.2)
47-47: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
CONTRIBUTING/README.md(1 hunks)CONTRIBUTING/development-setup.md(1 hunks)CONTRIBUTING/git.md(1 hunks)CONTRIBUTING/go.md(2 hunks)README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING/README.md
[style] ~5-~5: Consider an alternative adjective to strengthen your wording.
Context: ... interest, you can pick one and build a deeper understanding of the project on the go....
(DEEP_PROFOUND)
README.md
[grammar] ~27-~27: The word “setup” is a noun. The verb is spelled with a space.
Context: ...setup DiceDB for development or want to setup from source, refer > our [CONTRIBUTING/...
(NOUN_VERB_CONFUSION)
CONTRIBUTING/development-setup.md
[uncategorized] ~11-~11: This expression is usually spelled with a hyphen.
Context: ...upported platform environments: 1. [Linux based environment](https://en.wikipedia.org/w...
(BASED_HYPHEN)
[grammar] ~57-~57: The word “check-in” is a noun. The verb is spelled with a space.
Context: ...hat it is and why it is needed. Do not check-in the go.mod file with this change. ##...
(NOUN_VERB_CONFUSION)
[uncategorized] ~74-~74: Possible missing article found.
Context: ....go config-init ``` This will generate configuration file (dicedb.yaml) in metadata direct...
(AI_HYDRA_LEO_MISSING_A)
[typographical] ~80-~80: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... privileges, then these directories are used, otherwise the current working directory is used a...
(THUS_SENTENCE)
[uncategorized] ~106-~106: Did you mean: “By default,”?
Context: ... before you run the following commands. By default it connects to the local instance of Di...
(BY_DEFAULT_COMMA)
🪛 markdownlint-cli2 (0.17.2)
README.md
47-47: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
CONTRIBUTING/development-setup.md
16-16: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
17-17: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
18-18: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
26-26: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
34-34: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
35-35: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
36-36: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
50-50: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
62-62: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
63-63: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
71-71: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
77-77: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
78-78: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
117-117: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
🔇 Additional comments (10)
CONTRIBUTING/go.md (1)
33-37: New "Formatting and Linting" section is a clear and valuable addition.
This extra section directs contributors to complete the development setup and runmake lintto ensure code quality. The instructions are concise and provide a helpful pointer to the associated setup guide.CONTRIBUTING/git.md (2)
1-4: Overall structure and title are clear.
The new document “Git Best Practices” lays out a step-by-step approach for branch creation and pull request preparation. The content is well organized.
54-56: Final push commands are concise and accurate.
The instructions ensure that contributors know how to update their PRs after resolving conflicts.CONTRIBUTING/development-setup.md (2)
42-52: "Essentials for Development" instructions are clear.
The guidance for pointing to a local checked-outdicedb-goin thego.modfile is concise and precise.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
50-50: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
115-118: Integration test instructions are clear.
The final code block for running all integration tests is concise and directly to the point.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
117-117: Dollar signs used before commands without showing output
null(MD014, commands-show-output)
CONTRIBUTING/README.md (4)
1-10: Restructured contributor guide looks concise and welcoming.
The introduction and repository listing (lines 1–10) clearly outline how contributors can engage with different parts of the project. The links and repository descriptions are accurate and helpful.🧰 Tools
🪛 LanguageTool
[style] ~5-~5: Consider an alternative adjective to strengthen your wording.
Context: ... interest, you can pick one and build a deeper understanding of the project on the go....(DEEP_PROFOUND)
11-17: "Important Resources" section is well integrated.
The direct links to the new development setup, Git best practices, Go best practices, and logging best practices make it easy for contributors to locate essential guidelines.
18-27: Issue and PR timeline guidelines are clear.
The “Timeline for working on Issues” and “Pull Requests (PRs)” sections provide straightforward instructions on expectations and responsibilities, contributing to a smoother contribution process.
32-41: CLA and documentation guidance are concise.
The instructions regarding the Contributor License Agreement (CLA) and code documentation emphasize consistency and quality. The links provided are helpful for onboarding new contributors.README.md (1)
45-46: Linking to contribution guidelines is spot on.
Directing contributors to the CONTRIBUTING/README.md as the starting point is straightforward and encourages them to follow best practices.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (10)
CONTRIBUTING/docs.md (5)
3-3: Correct “NodeJS” to “Node.js” for Consistency
In the sentence "Once you have NodeJS installed…", please change "NodeJS" to "Node.js" to align with the official naming convention.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: # Development setup for Docs We use Astro framework t...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...uild/) to power the docs. Once you have NodeJS installed, fire the following commands ...(NODE_JS)
5-9: Review Command Block Formatting
The bash code block shows commands prefixed with a “$”. Ensure this styling is consistent with our markdown guidelines. If leading “$” is not required or preferred, consider removing it to avoid markdownlint warnings.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
6-6: Dollar signs used before commands without showing output
null(MD014, commands-show-output)
7-7: Dollar signs used before commands without showing output
null(MD014, commands-show-output)
8-8: Dollar signs used before commands without showing output
null(MD014, commands-show-output)
11-11: Refine Browser Instruction Wording
The sentence "Once the server starts, visit http://localhost:4321/ in your favourite browser." could be improved for clarity. Consider changing “in your favourite browser” to “on your favourite browser” and adding a comma after the URL if needed for better readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: A comma might be missing here.
Context: ...favourite browser. This runs with a hot reload which means any changes you make in the...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~11-~11: The usual collocation for technology is “on”, not “in”.
Context: ...reload which means any changes you make in the website and the documentation can be instantly ...(IN_THE_INTERNET)
🪛 markdownlint-cli2 (0.17.2)
11-11: Bare URL used
null(MD034, no-bare-urls)
13-14: Heading Level Consistency
The heading "### Docs directory structure" might better follow our hierarchy if changed to an h2 heading (i.e. “## Docs directory structure”), ensuring consistent heading levels throughout the document.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
13-13: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3(MD001, heading-increment)
15-16: Punctuation in List Items
The second bullet, "2.docs/src/content/docs/tutorialsis where all the tutorials are documented", would read more cleanly with a period at the end. Consider appending a period to each list item for consistency.🧰 Tools
🪛 LanguageTool
[uncategorized] ~16-~16: A period might be missing here.
Context: ...torials` is where all the tutorials are documented(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
CONTRIBUTING/README.md (2)
5-6: Enhance Descriptive Wording
The sentence "…you can pick one and build a deeper understanding of the project on the go." might be strengthened by using a more distinctive adjective. Consider alternatives like “a more profound understanding” to emphasize the learning opportunity.🧰 Tools
🪛 LanguageTool
[style] ~5-~5: Consider an alternative adjective to strengthen your wording.
Context: ... interest, you can pick one and build a deeper understanding of the project on the go....(DEEP_PROFOUND)
13-14: Clarify “Development Setup” Labels
The Important Resources section lists both "Development Setup" and "Development Setup for Docs". As these titles are very similar, consider renaming one for clearer differentiation (e.g. "App Development Setup" vs. "Docs Development Setup") if they serve distinct purposes.🧰 Tools
🪛 LanguageTool
[grammar] ~13-~13: This phrase is duplicated. You should probably use “Development Setup” only once.
Context: ... for DiceDB ## Important Resources - Development Setup - [Development Setup for Docs](https://github.com/dicedb/dic...(PHRASE_REPETITION)
README.md (3)
27-29: Grammatical Correction for Verb Usage
In the block quote starting at line 27, the phrases "setup DiceDB for development" and "setup from source" use “setup” as a verb. Please change these to “set up DiceDB for development” and “set up from source” to maintain correct grammatical usage. For example:- If you are looking to setup DiceDB for development or want to setup from source, refer - > our [CONTRIBUTING/development-setup.md](...) + If you are looking to set up DiceDB for development or want to set up from source, refer + > to our [CONTRIBUTING/development-setup.md](...)🧰 Tools
🪛 LanguageTool
[grammar] ~27-~27: The word “setup” is a noun. The verb is spelled with a space.
Context: ...setup DiceDB for development or want to setup from source, refer > our [CONTRIBUTING/...(NOUN_VERB_CONFUSION)
43-44: Heading Style Consistency
The heading "## Want to contribute?" appears in ATX style, but markdownlint suggests using setext style for some headings. Ensure that the heading style is consistent throughout the document or consider updating the markdownlint configuration if ATX is the preferred style.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
43-43: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
49-49: Heading Style for Sponsors Section
Similarly, the "## Sponsors" heading might be reviewed for style consistency with other headings in the file. If the project prefers setext headings in certain sections, consider aligning this section accordingly.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
49-49: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CONTRIBUTING/README.md(1 hunks)CONTRIBUTING/docs.md(1 hunks)README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING/docs.md
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: # Development setup for Docs We use Astro framework t...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~3-~3: The official spelling of this programming framework is “Node.js”.
Context: ...uild/) to power the docs. Once you have NodeJS installed, fire the following commands ...
(NODE_JS)
[uncategorized] ~11-~11: A comma might be missing here.
Context: ...favourite browser. This runs with a hot reload which means any changes you make in the...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~11-~11: The usual collocation for technology is “on”, not “in”.
Context: ...reload which means any changes you make in the website and the documentation can be instantly ...
(IN_THE_INTERNET)
[uncategorized] ~16-~16: A period might be missing here.
Context: ...torials` is where all the tutorials are documented
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
CONTRIBUTING/README.md
[style] ~5-~5: Consider an alternative adjective to strengthen your wording.
Context: ... interest, you can pick one and build a deeper understanding of the project on the go....
(DEEP_PROFOUND)
[grammar] ~13-~13: This phrase is duplicated. You should probably use “Development Setup” only once.
Context: ... for DiceDB ## Important Resources - Development Setup - [Development Setup for Docs](https://github.com/dicedb/dic...
(PHRASE_REPETITION)
README.md
[grammar] ~27-~27: The word “setup” is a noun. The verb is spelled with a space.
Context: ...setup DiceDB for development or want to setup from source, refer > our [CONTRIBUTING/...
(NOUN_VERB_CONFUSION)
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING/docs.md
6-6: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
7-7: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
8-8: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
11-11: Bare URL used
null
(MD034, no-bare-urls)
13-13: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
README.md
43-43: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
49-49: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
🔇 Additional comments (2)
CONTRIBUTING/README.md (1)
35-47: Content Clarity and Organization
The remainder of the file is concise and well organized. The restructuring, especially the placement of the CLA and contributor guidelines, makes the process clearer for new contributors.README.md (1)
43-48: Clear Navigation to Contribution Guidelines
The added section that directs readers to the "CONTRIBUTING/README.md" for contribution guidelines is an effective update. This clearly guides potential contributors to the comprehensive standards they should follow.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
43-43: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
Summary by CodeRabbit