Update internal repo docs for adding modules #2047
Open
jfy133 wants to merge 4 commits into
Open
Conversation
Updated the instructions for adding new test datasets, including a checklist for contributors.
Updated instructions for using new test data after PR merge.
mashehu
reviewed
May 11, 2026
| Please fill in the appropriate checklist below (delete whatever is not relevant). These are the most common things requested when adding a new test dataset. | ||
|
|
||
| - [ ] Familiarise yourself with the test-data [specifications](https://nf-co.re/docs/specifications/test-data/overview). | ||
| - [ ] Check [here](https://github.com/nf-core/test-datasets/branches/all) that there isn't already a branch containing data that could be used. |
Contributor
There was a problem hiding this comment.
not sure about this point...
Member
Author
There was a problem hiding this comment.
I've jsut copied from the master branch docs which seems to be more up to date
mashehu
reviewed
May 11, 2026
mashehu
reviewed
May 11, 2026
| - [ ] Create a new branch on your fork. | ||
| - [ ] Check your proposed test data follows the [guidelines](https://nf-co.re/docs/contributing/test_data_guidelines). | ||
| - [ ] Add your test dataset. | ||
| - [ ] Warning: this repository is extremely large. If you clone locally, ensure you use the command `git clone <url> --branch <branch> --single-branch` to clone only the branch of interest. |
Contributor
There was a problem hiding this comment.
this should be before the fork imo, usually people fork and clone at once
Member
Author
There was a problem hiding this comment.
Eh? I don't follow.
You would need to fork to your account, and then you would clone that, no?
Contributor
There was a problem hiding this comment.
yep, but people at this step usually already fork + clone, so will not read the next point before cloning.
Member
Author
There was a problem hiding this comment.
Ok I didn't know you can fork and clone at the same time, so please make a suggestion 😬
Contributor
There was a problem hiding this comment.
it's not really at the same time, but for example if you run gh repo fork, after you accept to fork you get immediately prompted if you also want to clone it.
mashehu
reviewed
May 11, 2026
Co-authored-by: Matthias Hörtenhuber <mashehu@users.noreply.github.com>
mashehu
reviewed
May 11, 2026
Comment on lines
+8
to
+11
| - [ ] Fork the [nf-core/test-datasets repository](https://github.com/nf-core/test-datasets) to your GitHub account. | ||
| - [ ] Create a new branch on your fork. | ||
| - [ ] Add your test dataset. | ||
| - [ ] Warning: this repository is extremely large. If you clone locally, ensure you use the command `git clone <url> --branch <branch> --single-branch` to clone only the branch of interest. |
Contributor
There was a problem hiding this comment.
Suggested change
| - [ ] Fork the [nf-core/test-datasets repository](https://github.com/nf-core/test-datasets) to your GitHub account. | |
| - [ ] Create a new branch on your fork. | |
| - [ ] Add your test dataset. | |
| - [ ] Warning: this repository is extremely large. If you clone locally, ensure you use the command `git clone <url> --branch <branch> --single-branch` to clone only the branch of interest. | |
| - [ ] Fork the [nf-core/test-datasets repository](https://github.com/nf-core/test-datasets) to your GitHub account. | |
| - [ ] Warning: this repository is extremely large. If you clone locally, ensure you use the command `git clone <url> --branch <branch> --single-branch` to clone only the branch of interest. | |
| - [ ] Create a new branch on your fork. | |
| - [ ] Add your test dataset. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.