nf-core / nf-core/website

Add a schema to params files

Open
#1,781 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
98
Forks
298
Avg merge
14h 38m
Merged PRs (30d)
38

Description

Is your feature request related to a problem? Please describe.
Toss in a schema to validate against when launching a workflow from the website. Probably a bit of overkill

Describe the solution you'd like

# yaml-language-server: $schema=https://my.url.to/the/schema
{
"input": "samplesheet.csv",
"genome": "hg19"
}

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

The issue does not name a file, test, or entry point; begin by locating the website code that handles workflow-launch parameter files and checking how those files are represented. Clarify the schema format, location, and validation boundary first, then verify that launching a workflow rejects invalid parameters and accepts the shown inputs.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, yaml
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.