Copy LICENSE when installing an nf-core hosted module
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Briefly discussed in the #modules channel of slack.
"Installing" a nf-core module with
e.g. nf-core modules install . -t untar
doesn't transfer a license, leaving it to the person installing to add a license. It would be nice for nf-core modules install to copy over a license(s) for the installed file(s).
@ewels mentioned:
maybe nf-core modules install should copy the repo license in with the module files..
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 tracing the implementation of nf-core modules install, using nf-core modules install . -t untar as the reproduction command. Check the existing module-installation tests and determine how repository license files should be selected and copied. Done means an installed module includes the applicable license file or files, with tests covering the behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100