add license check to linter
Nobody has claimed this yet.
- 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
- add code to the
nf-corelinter to check for a line inmeta.ymlsuch aslicense: ['MIT'] - ensure that
nf-core modules createalso 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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