Skip to content

chore: update README to v1.6.0 and remove outdated Requirements section#252

Merged
shenxianpeng merged 1 commit into
mainfrom
chore/update-readme-to-v1.6.0
Jul 7, 2026
Merged

chore: update README to v1.6.0 and remove outdated Requirements section#252
shenxianpeng merged 1 commit into
mainfrom
chore/update-readme-to-v1.6.0

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Jul 7, 2026

Copy link
Copy Markdown
Member

Summary

  • Removed the ## Requirements section that stated v1.5.0 and later requires Python 3.10 or newer — this is outdated since v1.5.0 is no longer current and the minimum Python requirement (3.10) is already defined in pyproject.toml.
  • Updated all rev: v1.5.0 references in example .pre-commit-config.yaml snippets to rev: v1.6.0.

Changes

File Change
README.md 9 insertions, 14 deletions — removed Requirements section, bumped all version refs to v1.6.0

Summary by CodeRabbit

  • Documentation
    • Updated the README examples to reference cpp-linter-hooks v1.6.0 throughout.
    • Refreshed related setup guidance, including clang-tidy --fix support and version references in configuration examples.
    • Removed the “Requirements” entry from the table of contents to match the updated document structure.

- Removed the Requirements section ("v1.5.0 and later requires Python 3.10+")
  since v1.5.0 is no longer current
- Updated all cpp-linter-hooks version references from v1.5.0 to v1.6.0
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 7, 2026
@sonarqubecloud

sonarqubecloud Bot commented Jul 7, 2026

Copy link
Copy Markdown

@codecov

codecov Bot commented Jul 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.51%. Comparing base (4619ff0) to head (2baf3e7).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #252   +/-   ##
=======================================
  Coverage   97.51%   97.51%           
=======================================
  Files           3        3           
  Lines         241      241           
=======================================
  Hits          235      235           
  Misses          6        6           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1ba202e8-ea93-4620-b082-67d121fa7e96

📥 Commits

Reviewing files that changed from the base of the PR and between 4619ff0 and 2baf3e7.

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

Walkthrough

README.md examples update the .pre-commit-config.yaml rev reference from v1.5.0 to v1.6.0 across Quick Start, custom configuration, clang tool version, compile database, verbose output, and performance sections. The Table of Contents "Requirements" entry and its corresponding section are removed.

Changes

README Documentation Updates

Layer / File(s) Summary
Version reference bump to v1.6.0
README.md
All .pre-commit-config.yaml example snippets (Quick Start, Custom Configuration Files, Custom Clang Tool Version, Compilation Database, clang-tidy Output, Performance Optimization, Verbose Output) and nearby guidance text update the rev value from v1.5.0 to v1.6.0.

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

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the README version update and removal of the outdated Requirements section.
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.

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.

@shenxianpeng shenxianpeng merged commit 1685121 into main Jul 7, 2026
32 checks passed
@shenxianpeng shenxianpeng deleted the chore/update-readme-to-v1.6.0 branch July 7, 2026 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant