LCORE-587: fixed typos in contributing guide

[tisnik]

Description

LCORE-587: fixed typos in contributing guide

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement

Tools used to create PR

Identify any AI code assistants used in this PR (for transparency and review context)

• Assisted-by: N/A
• Generated by: N/A

Related Tickets & Documents

• Related Issue #
• Closes #

Checklist before requesting a review

• I have performed a self-review of my code.
• PR has passed all pre-merge test jobs.
• If it is a core feature, I have added thorough tests.

Testing

• Please provide detailed steps to perform tests related to this code change.
• How were the fix/results from this change verified? Please provide relevant screenshots or results.

Summary by CodeRabbit

• Documentation
  • Refined contributing guidelines with grammatical corrections and stylistic improvements to enhance clarity and readability for all contributors.
  • Standardized terminology, technical examples, and formatting conventions throughout the documentation to maintain consistency across all sections.
  • Updated language choices and phrasing for improved precision and professional presentation.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Minor grammatical and stylistic corrections to CONTRIBUTING.md, including definite article additions, standardized abbreviations (e.g., versus eg.), and phrasing improvements. No functional or logic changes.

Changes

Cohort / File(s)	Change Summary
Documentation grammar and style fixes CONTRIBUTING.md	Added definite articles ("the defined threshold"), standardized abbreviations (eg. → e.g.), replaced awkward phrasing ("us" → "such as"), improved sentence clarity and consistency in Code Coverage and Linters sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• This is purely cosmetic documentation editing with no logic, control flow, or functional changes.

Possibly related PRs

• LCORE-304: devel documentation #262: Applies minor editorial fixes (typos/grammar) to CONTRIBUTING.md with similar scope and nature.
• LCORE-587: Updated contributing guide #836: Makes documentation-only edits to the contributing guide for consistency.
• LCORE-663: Updated contributing guide #532: Modifies CONTRIBUTING.md with both grammatical/stylistic fixes and structural reorganization of the guide.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately describes the main change: fixing typos in the contributing guide, which aligns with the file-level summary showing grammatical and stylistic corrections.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

CONTRIBUTING.md (1)

159-159: Good grammatical improvement with optional wording refinement.

The addition of the definite article "the" is correct. However, the static analysis tool flags the phrase "in order to be able to" as unnecessarily verbose; consider simplifying to "to develop software with high quality" for conciseness.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9c05e1b and ddc88af.

📒 Files selected for processing (1)

• CONTRIBUTING.md (3 hunks)

🧰 Additional context used

🧠 Learnings (2)

📚 Learning: 2025-11-24T16:58:04.410Z

Learnt from: CR
Repo: lightspeed-core/lightspeed-stack PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T16:58:04.410Z
Learning: Applies to tests/{unit,integration}/**/*.py : Unit tests must achieve 60% code coverage; integration tests must achieve 10% coverage

Applied to files:

• CONTRIBUTING.md

📚 Learning: 2025-11-24T16:58:04.410Z

Learnt from: CR
Repo: lightspeed-core/lightspeed-stack PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T16:58:04.410Z
Learning: Run `uv run make verify` to run all linters (black, pylint, pyright, ruff, docstyle, check-types) before completion

Applied to files:

• CONTRIBUTING.md

🪛 LanguageTool

CONTRIBUTING.md

[style] ~159-~159: Consider a more concise word here.
Context: .... We measured and checked code coverage in order to be able to develop software with high q...

(IN_ORDER_TO_PREMIUM)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: build-pr
• GitHub Check: e2e_tests (azure)
• GitHub Check: e2e_tests (ci)
• GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request

🔇 Additional comments (3)

CONTRIBUTING.md (3)

167-167: Clarity improvement: "us" → "such as".

The correction from unclear "us" phrasing to "such as" significantly improves sentence clarity and readability.

---

194-194: Clear scope documentation.

The addition of "(for a given line or block)" appropriately clarifies the scope of the noqa comment functionality.

---

254-254: Proper abbreviation standardization.

Standardizing "eg." to "e.g." follows formal English writing conventions for this Latin abbreviation.