Add info about profile test in TEMPLATE
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
So maybe a small mention in the main README that point towards a more general explanation about how we use that in nf-core + a more detailed explanation in the usage.md docs.
cf this Slack discussion: https://nfcore.slack.com/archives/CE8SSJV3N/p1686841387377349
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 reading the main README and usage.md, then review the linked Slack discussion for the meaning of the profile test in TEMPLATE. Document the profile test in the README and provide the more detailed explanation in usage.md; done means both references clearly explain how nf-core uses it.
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
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100