Add docs/development section for tips on contributors adding new modes
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 115
- Forks
- 75
- PR merge metrics
- No merged PRs in 30d
Description
Newer pipeline releases will have further 'value-add' features (accessible metrics, .mmcif, MultiQC) beyond base execution of the container.
The nf-test suites will act as contractual validators that the required info is being provided by any new --mode
For any contributoring developer (range of backgrounds), the 'contributing new modes may need to be expanded to include how to pass non-autodetected info into versions.yml, etc.
If it becomes details I'd advocate separating off docs/usage from docs/development, while keeping the fantastic per-mode usage exposed to the nf-core public page.
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 docs/usage/HOWTO_CONTRIBUTE_NEW_MODES.md and review the nf-test suites and versions.yml references mentioned in the issue. Decide what contributor guidance belongs in a new docs/development section, while preserving the per-mode usage documentation. Done means the new-mode workflow and non-autodetected metadata requirements are documented clearly for contributors.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 48/100