Skip to content

Update internal repo docs for adding modules #2047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jfy133 wants to merge 4 commits into
base: modules
Choose a base branch
from
Open

Update internal repo docs for adding modules #2047

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a0eec60
Revise instructions for adding new test datasets
jfy133 May 11, 2026
7083bcf
Revise test data instructions in ADD_NEW_DATA.md
jfy133 May 11, 2026
8aae985
Update docs/ADD_NEW_DATA.md
jfy133 May 11, 2026
cf1eca6
Update docs/ADD_NEW_DATA.md
jfy133 May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions docs/ADD_NEW_DATA.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# How to add new test data
# How to add and use new test dataset

- collect/generate your test dataset
- make sure your test data is working with the module(s) it is designed for
- make a fork of the `nf-core/test-dataset` repository
- add the test data to your fork (checkout and use the `modules` branch)
- git fetch upstream modules
- git checkout -b modules upstream/modules
- git push -u origin modules
- make a pull request to the `modules` branch from your fork of `nf-core/test-datasets`
- once the pull request is accepted, you can change the paths to the test data for your module(s) on `nf-core/modules`
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.

@mashehu mashehu May 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure about this point...

@jfy133 jfy133 May 11, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've jsut copied from the master branch docs which seems to be more up to date

- If this is the case, follow the [documentation on how to use an existing test dataset](https://github.com/nf-core/test-datasets/blob/master/docs/USE_EXISTING_DATA.md)
- [ ] 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.

@mashehu mashehu May 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be before the fork imo, usually people fork and clone at once

@jfy133 jfy133 May 11, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eh? I don't follow.

You would need to fork to your account, and then you would clone that, no?

@mashehu mashehu May 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, but people at this step usually already fork + clone, so will not read the next point before cloning.

@jfy133 jfy133 May 11, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I didn't know you can fork and clone at the same time, so please make a suggestion 😬

@mashehu mashehu May 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +8 to +11

@mashehu mashehu May 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

- [ ] Make a PR on a new branch with a relevant name.
Comment thread
jfy133 marked this conversation as resolved.
- [ ] In case you accidentally commited large datasets in a PR, drop the specific commits using git rebase.
- [ ] Wait for the PR to be merged. Once merged, use your new test data as described on the main [README](https://github.com/nf-core/test-datasets/blob/master/docs/USE_EXISTING_DATA.md).