Skip to content

Mention MegaLinter in README - #462

Merged
cclauss merged 2 commits into
cpplint:developfrom
nvuillam:readme-megalinter
Aug 10, 2026
Merged

Mention MegaLinter in README#462
cclauss merged 2 commits into
cpplint:developfrom
nvuillam:readme-megalinter

Conversation

@nvuillam

@nvuillam nvuillam commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Hi! I maintain MegaLinter, an open-source linters aggregator for CI that runs cpplint out of the box, so I figured a short line in the README next to the pre-commit section could help people discover another way to use it. If anything looks off on our cpplint page, happy to fix it on our side!

Summary by CodeRabbit

  • Documentation
    • Updated installation guidance to clarify that cpplint is included by default in MegaLinter.
    • Added links to MegaLinter and its cpplint documentation.

@coderabbitai

coderabbitai Bot commented Aug 8, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 40b315f5-d721-417a-b0ba-08ce10c044ff

📥 Commits

Reviewing files that changed from the base of the PR and between 3d6e698 and da6365d.

📒 Files selected for processing (1)
  • README.rst
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.rst

📝 Walkthrough

Walkthrough

README.rst states that MegaLinter includes cpplint by default. It links to MegaLinter and its cpplint documentation.

Changes

Documentation update

Layer / File(s) Summary
MegaLinter availability documentation
README.rst
The installation documentation describes cpplint availability in MegaLinter and links to related documentation.

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

🚥 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 clearly and concisely describes the README change that mentions MegaLinter.
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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.rst`:
- Line 53: Update the MegaLinter description in the README sentence to use the
singular noun modifier “an open-source linter aggregator,” leaving the
surrounding wording and links unchanged.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 04b8ab51-dc6f-4ee4-96b5-c996a388608b

📥 Commits

Reviewing files that changed from the base of the PR and between 96db7ae and 3d6e698.

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

Comment thread README.rst Outdated
@cclauss

cclauss commented Aug 8, 2026

Copy link
Copy Markdown
Member

I can see how you and MegaLinter benefit from the proposed changes but I struggle to see how this community benefits from them. We are trying to solicit feedback from the users of our tools and encourage them to open issues and pull requests to improve their user experience. In Open Source, building community input and contributions are a superpower.

If instead we encourage our users to engage with MegaLinter then we lose much of that valuable contact them and play second fiddle to an unrelated freemium product. How will MegaLinter improve the cpplint community and the quality of the results of our linter?

@nvuillam

nvuillam commented Aug 8, 2026

Copy link
Copy Markdown
Contributor Author

@cclauss MegaLinter is not a freemium, it's 100% free and open-source, even if backed by OX Security, which has different services

About community, it's not rare that people discover some linters thanks to MegaLinter, and sometimes they report issues related to embedded linters... that i redirect to the related linter own repo , allowing it to have more feedback ^^

But your repo = your rules, if you want to close the PR that's ok :)

@cclauss

cclauss commented Aug 9, 2026

Copy link
Copy Markdown
Member

The freemium comment was under a URL that points to MegaLinter's C++ linters.

Let's allow @aaronliu0130 decide on this PR.

@yangfan-yf-yf yangfan-yf-yf left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked the current MegaLinter descriptor and its cpplint documentation. The descriptor installs cpplint 2.0.2 in the C profiles, links back to this repository, and the two links added here resolve to the expected project and cpplint page. The change is documentation-only, and the hosted test matrix and documentation checks are green.

From a technical and documentation-accuracy standpoint, I found no blocker. LGTM.

@androvonx95 androvonx95 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the current PR against develop (96db7ae).

The README change is accurate, minimal, and correctly placed. I verified both MegaLinter links resolve and the referenced cpplint integration is present. I found no issues with the change.

LGTM.

@aaronliu0130 aaronliu0130 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I generally dislike mentioning specific package managers (since there could be an infinity of those), and that this technically means cpplint is listed on npm disturbs me (/tease), yet I don't feel strongly enough to oppose this (given that the tool is copyleft). I could reconsider if this becomes precedent for lots more PRs to come, but I hope that's unlikely :).

I'm not comfortable calling this review my decision, but I guess if none of we maintainers feel strongly enough to oppose this, we could merge this in and revert it later.

@cclauss
cclauss merged commit 169933e into cpplint:develop Aug 10, 2026
8 checks passed
@cclauss

cclauss commented Aug 10, 2026

Copy link
Copy Markdown
Member

Let’s do it. Megalinter is broadly known for consistent delivery.

@nvuillam

Copy link
Copy Markdown
Contributor Author

Thanks for the merge, and long live cpplint 😊😊

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.

5 participants