Document the structure/schema of .nf-core.yml
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
The .nf-core.yml file can now contain several sections of settings and information for a repo.
We should look to maintain documentation and/or a schema to make it easier to parse and check for users.
Thoughts:
- Schema for full yaml spec in python are not geat
- Could restrict to subset of YAML which is also valid JSON
- If not using a schema it would be good to make the documentation easily accessible at the CLI still
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 inventorying the sections currently supported in .nf-core.yml and reviewing how nf-core exposes information through its CLI. Resolve whether the deliverable is a YAML schema, documentation, or both; done means users can find a complete description and reliably parse or validate the supported settings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100