Skip to content

docs: fix punctuation in CONTRIBUTING.md test section - #1762

Open
amir-rezaei wants to merge 1 commit into
lightly-ai:mainfrom
amir-rezaei:docs/fix-contributing-punctuation-formatting
Open

docs: fix punctuation in CONTRIBUTING.md test section#1762
amir-rezaei wants to merge 1 commit into
lightly-ai:mainfrom
amir-rezaei:docs/fix-contributing-punctuation-formatting

Conversation

@amir-rezaei

@amir-rezaei amir-rezaei commented Jul 23, 2026

Copy link
Copy Markdown

Description

This PR fixes minor punctuation in CONTRIBUTING.md under the test commands section.

Details

Fixed To run static checks and unit tests use the following commands -> To run static checks and unit tests, use the following commands:.

Summary by CodeRabbit

  • Documentation
    • Clarified the “Development Quickstart” instructions with minor punctuation updates.

@amir-rezaei
amir-rezaei requested a review from a team as a code owner July 23, 2026 19:42
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f16c80d9-0735-44b3-bf5e-bc771cbf7d91

📥 Commits

Reviewing files that changed from the base of the PR and between 266526e and fe7509a.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

📝 Walkthrough

Walkthrough

Updated punctuation in the Development Quickstart instructions for static checks and unit tests.

Changes

Contributing Guide

Layer / File(s) Summary
Quickstart command introduction
CONTRIBUTING.md
The introductory sentence for the static checks and unit test commands now includes a comma and trailing period.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: ikondrat

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the docs-only punctuation fix in CONTRIBUTING.md.
Description check ✅ Passed It explains the change and why, but omits the testing and changelog sections from the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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.

3 participants