nf-core / nf-core/tools

Linting or GHA to test whether all modules of a module suite are updated

Open
#4,355 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement linting modules
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of feature

If a contributor updates modules on the nf-core/modules repository I usually check during the review whether they did it for all subtools that are part of the module. This is tedious and I think it can be automated. It would be nice to have some sort of automated reporting (for example by the bot) that tells me a warning if not all subtools are updated in that PR.

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 tracing the repository's existing linting and GitHub Actions checks, then review how module suites and their subtools are represented. Define how an update is detected across a pull request and what automated warning should report when a subtool is missed; done means the check reliably identifies incomplete module-suite updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.