nf-core / nf-core/tools

add license check to linter

Open
#1,295 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Is your feature request related to a problem? Please describe

as part of software best practices, it's probably wise (and sometimes maybe necessary) to include software licenses for packaged software. for nf-core/modules, this would mean enforcing or at least noting the software license in meta.yml

Describe the solution you'd like

  1. add code to the nf-core linter to check for a line in meta.yml such as license: ['MIT']
  2. ensure that nf-core modules create also generates this line when templating a new module

Describe alternatives you've considered

could opt for no-build option, if people are happy with status quo. for those in environments with high audit risk, this could yield a rather painful experience down the road..

Additional context

see parallel issue in nf-core/modules here

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 nf-core linter implementation and the nf-core modules create template entry point. Check how meta.yml fields are currently validated and generated, then define the expected license format and verify both requested behaviors with the project's existing checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, 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.