nf-core / nf-core/modules

Automated PR reviews of by github copilot using your module specifications as Agents.md

Open
#10,946 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nextflow
Stars
429
Forks
1.1k
Avg merge
1d 6h
Merged PRs (30d)
153

Description

Is your feature request related to a problem? Please describe

I notice there a large volume of PR's open. This is understandable as your reviewers have a fairly niche intersections of skill sets.

Describe the solution you'd like

It would help if github copilot could review a PR initially, providing specific guidance to contributors that has already been documented here in great detail, but in the context of their changes.
https://nf-co.re/docs/guidelines/components/modules

https://agents.md/ provides further reading, but effectively placing the file AGENTS.md in the root of a repo will form a readme for an agent. PR's can be configured to be automatically reviewed by copilot.

This would mean

  • contributors get a 5 minute turn around time until their first feedback on a PR
  • reviews get a PR containing code that is more conformant to their specification.
  • updates to the module speciifcations over time will be easier to enforce.
  • retroactive reviews of existing modules might be possible
Describe alternatives you've considered

No response

Additional context

Personally I have found them very effective as an initial review, especially where a repo has a narrow / targeted scope like this modules repo does.

Copilot code review now available for organization members without a license:
https://github.blog/changelog/2025-12-17-copilot-code-review-now-available-for-organization-members-without-a-license

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the module guidelines at nf-co.re/docs/guidelines/components/modules and the linked agents.md guidance. Determine how AGENTS.md and GitHub Copilot PR reviews would apply to this repository, including how updated specifications and existing modules should be handled. Done means an agreed, maintainable approach for automated reviews is documented and configured.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
ci-cd, developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.