`validate_params` default to `true`, but nf-core guidelines says boolean parameters should default to `false`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
validate_params in the nextflow schema defaults to true:
https://github.com/nf-core/tools/blob/99b23f0366232d793a82e71f28b2e621c382b889/nf_core/pipeline-template/nextflow_schema.json#L219-L225
However, according to the release review guidelines, boolean parameters should default to false:
https://github.com/nf-core/website/blob/c8a6b02cd2a0d42489f0431313bb9135963977d1/sites/docs/src/content/docs/checklists/reviews/pipeline_release_pr.md?plain=1#L52-L54
For consistency with the guidelines, shouldn't validate_params be renamed skip_param_validation and default to false instead?
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 with nf_core/pipeline-template/nextflow_schema.json at the validate_params definition and compare it with the linked pipeline release review guideline. Search the repository for validate_params and any related skip_param_validation references before deciding the scope. Done means the schema naming and default behavior consistently follow the guideline.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100