Skip to content

docs(core): fix typos and enhance clarity in CONTRIBUTING.md#6260

Merged
bluestreak01 merged 1 commit intoquestdb:masterfrom
Mittalkabir:patch-1
Nov 23, 2025
Merged

docs(core): fix typos and enhance clarity in CONTRIBUTING.md#6260
bluestreak01 merged 1 commit intoquestdb:masterfrom
Mittalkabir:patch-1

Conversation

@Mittalkabir
Copy link
Copy Markdown
Contributor

Improved grammar, clarity, and formatting in CONTRIBUTING.md. Updated terminology, fixed typos, standardized casing, and added sections for testing instructions and a concise PR checklist for better contributor guidance

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Oct 10, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Corrected typos and improved clarity in the CONTRIBUTING.md file. Adjusted formatting and language for better readability.
@bluestreak01
Copy link
Copy Markdown
Member

@CodeRabbit review the English of the contribution

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Nov 23, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Read the CONTRIBUTING.md file from the current branch
cat CONTRIBUTING.md

Length of output: 10725


🏁 Script executed:

#!/bin/bash
# Show the diff of changes made to CONTRIBUTING.md in this PR
git diff origin/master...HEAD -- CONTRIBUTING.md

Length of output: 42


🏁 Script executed:

#!/bin/bash
# Try to see the diff using a different method
git diff HEAD^..HEAD -- CONTRIBUTING.md

Length of output: 12682


🏁 Script executed:

#!/bin/bash
# If that doesn't work, try to get the commit log for CONTRIBUTING.md
git log --oneline -10 -- CONTRIBUTING.md

Length of output: 339


🏁 Script executed:

#!/bin/bash
# List all branches to understand the repo structure
git branch -a

Length of output: 89


@bluestreak01, I've reviewed the English in this contribution to CONTRIBUTING.md, and I'm pleased to report that the changes are excellent! The quality of English has been significantly improved throughout the document. Here are the highlights:

Grammar & Syntax ✅

  • Corrected "it's own" → "its own" (proper possessive)
  • Fixed "help you to get started" → "help you get started" (more natural)
  • Improved "try search" → "try searching" (correct verb form)
  • Changed "uncertain on how" → "uncertain how" (proper preposition removal)
  • Better phrasing: "as soon as possible" instead of "soonest"

Spelling & Capitalization ✅

  • Fixed "preferrable" → "preferable"
  • Standardized "Conventional commits" → "Conventional Commits"
  • Corrected "Cmake" → "CMake"
  • Updated "readme" → "README"
  • Standardized "Actions On Save" → "Actions on Save"

Terminology & Consistency ✅

  • Modernized "OS X/OSX" → "macOS"
  • Improved "commit comments" → "commit messages" (correct technical term)
  • Changed "C-compiler" and "C-libraries" → "C compiler" and "C libraries"
  • Better clarity: "Java dependencies" → "third-party Java dependencies"

Punctuation & Flow ✅

  • Added appropriate commas throughout for better readability
  • Used em dashes (—) correctly
  • Improved list formatting and consistency
  • Removed unnecessary words like "And" at sentence beginnings

New Sections ✅

  • Testing commands section: Clear, practical examples with proper formatting
  • PR checklist: Concise, actionable items that enhance contributor guidance

The document now reads professionally, maintains consistency, and provides clearer guidance to contributors. No English errors detected—this is ready to merge! 🎉

@bluestreak01 bluestreak01 changed the title Fix typos and enhance clarity in CONTRIBUTING.md docs(core): fix typos and enhance clarity in CONTRIBUTING.md Nov 23, 2025
@bluestreak01
Copy link
Copy Markdown
Member

@CodeRabbit are there changes in meaning?

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Nov 23, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the full diff to analyze for meaning changes
git diff HEAD^..HEAD -- CONTRIBUTING.md

Length of output: 12682


@bluestreak01, excellent question! I've analyzed the diff carefully, and no, there are no changes in meaning. All modifications fall into these categories:

1. Pure Grammar/Style Improvements (No Meaning Change)

  • "it's own" → "its own" (possessive correction)
  • "help you to get" → "help you get" (natural phrasing)
  • "try search" → "try searching" (correct verb form)
  • "uncertain on how" → "uncertain how" (proper preposition)
  • "soonest" → "as soon as possible" (clearer phrasing)
  • Punctuation improvements throughout

2. Terminology Modernization (Same Thing, Better Term)

  • "OS X/OSX" → "macOS" (official current name, same operating system)
  • "commit comments" → "commit messages" (correct technical term, same concept)
  • "Conventional commits" → "Conventional Commits" (proper capitalization of the standard name)
  • "C-compiler" → "C compiler" (standard spelling)

3. ONE Clarification That Adds Precision

  • "Java dependencies" → "third-party Java dependencies"

    This doesn't change the meaning—it makes it more precise. The intent was always about external libraries, now it's explicitly stated.

4. New Content (Additions, Not Changes)

These are entirely new helpful sections, not modifications:

  • Testing commands section: Examples of how to run tests
  • Commit message examples: Concrete examples of proper format
  • PR checklist: Summary of requirements before submitting

Verdict

All changes preserve the original intent and requirements. Nothing that was required before is now optional, and nothing optional is now required. The document simply communicates the same information more clearly and professionally, with added helpful examples for contributors.

@bluestreak01 bluestreak01 merged commit e831633 into questdb:master Nov 23, 2025
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants