nf-core / nf-core/tools

Code maintenance: reduce duplicated code

Open
#2,518 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of feature

Since the introduction of subworkflows, there is some duplicated code between modules and subworkflows. This can be unified with components to avoid code duplication.
Specifically, some linting tests could easily be unified into components linting:

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

Compare the linked module and subworkflow lint files, especially module_changes.py with subworkflow_changes.py, module_todos.py with subworkflow_todos.py, and module_version.py with subworkflow_version.py. Read the completed module_tests.py and subworkflow_tests.py unification for context, then consolidate the remaining duplicated checks into components linting and verify the linting behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing-qa, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.