nf-core / nf-core/tools

Licence linting doesn't check if the string is a list containing an array.

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

Nobody has claimed this yet.

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

Description

Description of the bug

There are many meta.yml files on nf-core/modules which have the following pattern.

licence: "['LICENCE']"

which is confusing as it's a string containing an array.
The value should either be "LICENCE" or ['LICENCE1','LICENCE2'], but not a mixture of both.

Command used and terminal output

No response

System information

No response

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 locating the licence linting entry point that validates meta.yml files for nf-core/modules, then trace how the licence value is classified. Reproduce the reported string containing an array and verify that the accepted scalar and array forms remain valid while the mixed form is rejected.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.