List plugin interface repos in README

[jlumpe]

Summary by CodeRabbit

• Documentation
  • Expanded README from a brief description to a structured overview.
  • Added “Interfaces for specific plugin types” section with links to six plugin categories: Storage, Logger, Executor, Scheduler, Report, and Software deployment.
  • Improves discoverability and onboarding by directing users to relevant repositories and documentation.
  • No functional changes.

[coderabbitai]

📝 Walkthrough

Walkthrough

Expands README.md from a brief description to a structured list detailing interfaces for six plugin types, each linking to its respective repository. No code or API changes.

Changes

Cohort / File(s)	Summary
Documentation README.md	Rewrote README to include “Interfaces for specific plugin types” with links for Storage, Logger, Executor, Scheduler, Report, and Software deployment plugins; no functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

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 title "List plugin interface repos in README" succinctly and accurately describes the main change, which adds a list of plugin interface repositories and links to the README. It is a single clear sentence that directly reflects the changeset and is specific enough for a reviewer scanning history to understand the primary intent.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

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 (2)

README.md (2)

3-3: Tighten repo description to reflect interfaces

Suggest clarifying that this repo provides shared interface/base definitions rather than generic “functions and classes.”

Apply:

-Common functions and classes for Snakemake and its plugins.
+Common interface definitions and base classes used by Snakemake and its plugins.

---

6-13: Good addition. Consider brief per-type descriptors and a lead-in sentence

This looks useful. A short lead-in and concise descriptors per item will help newcomers pick the right interface quickly.

Proposed tweak:

 ## Interfaces for specific plugin types
+
- - Storage: [snakemake-interface-storage-plugins](https://github.com/snakemake/snakemake-interface-storage-plugins)
- - Logger: [snakemake-interface-logger-plugins](https://github.com/snakemake/snakemake-interface-logger-plugins)
- - Executor: [snakemake-interface-executor-plugins](https://github.com/snakemake/snakemake-interface-executor-plugins)
- - Scheduler: [snakemake-interface-scheduler-plugins](https://github.com/snakemake/snakemake-interface-scheduler-plugins)
- - Report: [snakemake-interface-report-plugins](https://github.com/snakemake/snakemake-interface-report-plugins)
- - Software deployment: [snakemake-interface-software-deployment-plugins](https://github.com/snakemake/snakemake-interface-software-deployment-plugins)
+The following repositories define the plugin interfaces for each subsystem:
+
+- Storage: [snakemake-interface-storage-plugins](https://github.com/snakemake/snakemake-interface-storage-plugins) — remote/object store and filesystem backends
+- Logger: [snakemake-interface-logger-plugins](https://github.com/snakemake/snakemake-interface-logger-plugins) — structured logging sinks/handlers
+- Executor: [snakemake-interface-executor-plugins](https://github.com/snakemake/snakemake-interface-executor-plugins) — job submission and execution backends
+- Scheduler: [snakemake-interface-scheduler-plugins](https://github.com/snakemake/snakemake-interface-scheduler-plugins) — scheduling strategies and policies
+- Report: [snakemake-interface-report-plugins](https://github.com/snakemake/snakemake-interface-report-plugins) — report generation and rendering
+- Software deployment: [snakemake-interface-software-deployment-plugins](https://github.com/snakemake/snakemake-interface-software-deployment-plugins) — environment/software provisioning

Also please click through each link to verify they resolve to the intended repos and are up to date with current plugin taxonomy.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d716954 and 6e7fe9d.

📒 Files selected for processing (1)

• README.md (1 hunks)