nf-core / nf-core/test-datasets
What should we do with `docs/ADD_NEW_DATA.md` and `docs/USE_EXISTING_DATA.md` on pipeline branches?
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 164
- Forks
- 530
- Avg merge
- 7h 9m
- Merged PRs (30d)
- 48
Description
It seems like not all branch handle ADD_NEW_DATA.md and USE_EXISTING_DATA.md in the same way. For instance, rnaseq and methylseq have deleted them, while sarek and demultiplex still have them. Is this something we want to standardize between all the branches? Or should we only keep these files on the default branch maybe?
Contributor guide
No contributing guide indexed for this repository
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 comparing docs/ADD_NEW_DATA.md and docs/USE_EXISTING_DATA.md across the rnaseq, methylseq, sarek, demultiplex, and default branches. Done means deciding whether these files should be standardized across pipeline branches or retained only on the default branch, then documenting and applying that decision.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100