nf-core / nf-core/tools

Add --no-tests flag to nf-core modules install

Open
#2,492 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

nf-test pipeline-testing
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

The discussion we had at the hackathon was that by default the tests should be installed, and users should have to opt-out of the bad practice of not testing.

However, I think instead it might be simpler for everyone to not install the tests, unless the user runs nf-core modules patch and then the tests get installed. The tests would get removed when they remove the patch.

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 reviewing the nf-core modules install and nf-core modules patch command entry points and their current test-handling behavior. Resolve whether the desired change is an explicit --no-tests opt-out or installing tests only after patching, then define completion around consistent installation and removal behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.