nf-core / nf-core/tools

Enable configurations for module linting

Open
#3,656 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of feature

On a module level we can currently only decide if we want to run the linting for a file or not. This is for all linting in that file. When hosting a modules repo outside of nf-core it would be helpful to be able to configure the linting more granularly, for example: lint the main.nf but skip linting for whether a label is present.

Slack convo: https://nfcore.slack.com/archives/CE5LG7WMB/p1751539469307559

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

The issue names no files or tests; start by locating the module-level lint configuration and the code that selects lint rules for a file. Done means a module can enable linting for selected files while skipping individual checks such as label presence, with coverage for the configuration behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.