Skip to content

docs: mention MegaLinter in the CI integration section - #314

Merged
mbhall88 merged 2 commits into
snakemake:masterfrom
nvuillam:mention-megalinter
Aug 18, 2026
Merged

mbhall88 merged 2 commits into
snakemake:masterfrom
nvuillam:mention-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, and snakefmt has been part of it for a while (descriptor page: https://megalinter.io/latest/descriptors/snakemake_snakefmt/).

Since the README already points to super-linter for running snakefmt in CI, I figured a short line about MegaLinter could help users who prefer that route. Feel free to tweak the wording or close if you'd rather keep the section minimal!

Summary by CodeRabbit

  • Documentation
    • Added MegaLinter as an alternative CI linting option.
    • Documented that it supports snakefmt out of the box.
    • Included a link to the MegaLinter setup guide.

@nvuillam
nvuillam requested a review from mbhall88 as a code owner August 8, 2026 18:15
@coderabbitai

coderabbitai Bot commented Aug 8, 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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 352ab1a2-d6b0-4ff7-9a98-407cb07fb9ac

📥 Commits

Reviewing files that changed from the base of the PR and between 2ac8e82 and db6ed24.

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

📝 Walkthrough

Walkthrough

The README now documents MegaLinter as an alternative CI linter aggregator and links to its snakefmt integration setup page.

Changes

MegaLinter documentation

Layer / File(s) Summary
Add MegaLinter integration documentation
README.md
The README describes MegaLinter as an alternative CI linter aggregator and links to its snakefmt integration setup page.

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

Suggested reviewers: mbhall88

🚥 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 update to mention MegaLinter in the CI integration 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.
✨ 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
Contributor

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.md`:
- Line 642: Update the README sentence beginning “Alternatively, MegaLinter” to
use the singular noun phrase “linter aggregator” instead of “linters
aggregator,” preserving the link and surrounding wording.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: e89cba68-2d30-4876-a681-54b5cc99a9f5

📥 Commits

Reviewing files that changed from the base of the PR and between fdfb5d9 and 2ac8e82.

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

Comment thread README.md Outdated
@mbhall88
mbhall88 merged commit 06b1871 into snakemake:master Aug 18, 2026
3 checks passed
@nvuillam

Copy link
Copy Markdown
Contributor Author

Thanks a lot 😉

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