Skip to content

Commit 0f5c125

Browse files
committed
fix linting
# Conflicts: # docs/ADD_NEW_DATA.md # docs/USE_EXISTING_DATA.md
1 parent 25b8a05 commit 0f5c125

4 files changed

Lines changed: 21 additions & 20 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# ![nfcore/test-datasets](docs/images/test-datasets_logo.png)
2+
23
Test data to be used for automated testing with the nf-core pipelines
34

45
> ⚠️ **Do not merge your test data to `master`! Each pipeline has a dedicated branch (and a special one for modules)**
@@ -13,8 +14,8 @@ The principle for nf-core test data is as small as possible, as large as necessa
1314

1415
nf-core/test-datasets comes with documentation in the `docs/` directory:
1516

16-
01. [Add a new test dataset](https://github.com/nf-core/test-datasets/blob/master/docs/ADD_NEW_DATA.md)
17-
02. [Use an existing test dataset](https://github.com/nf-core/test-datasets/blob/master/docs/USE_EXISTING_DATA.md)
17+
1. [Add a new test dataset](https://github.com/nf-core/test-datasets/blob/master/docs/ADD_NEW_DATA.md)
18+
2. [Use an existing test dataset](https://github.com/nf-core/test-datasets/blob/master/docs/USE_EXISTING_DATA.md)
1819

1920
## Downloading test data
2021

docs/ADD_NEW_DATA.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
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.
44

5-
- [ ] Check [here](https://github.com/nf-core/test-datasets/branches/all) that there isn't already a branch containing data that could be used
6-
- 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)
7-
- [ ] Fork the [nf-core/test-datasets repository](https://github.com/nf-core/test-datasets) to your GitHub account
8-
- [ ] Create a new branch on your fork
9-
- [ ] Check your proposed test data follows the [guidelines](https://nf-co.re/docs/contributing/test_data_guidelines)
10-
- [ ] Add your test dataset
11-
- [ ] If you clone it locally use `git clone <url> --branch <branch> --single-branch`
12-
- [ ] Make a PR on a new branch with a relevant name
13-
- [ ] Wait for the PR to be merged
14-
- [ ] Use this newly created branch for your tests
5+
- [ ] Check [here](https://github.com/nf-core/test-datasets/branches/all) that there isn't already a branch containing data that could be used
6+
- 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)
7+
- [ ] Fork the [nf-core/test-datasets repository](https://github.com/nf-core/test-datasets) to your GitHub account
8+
- [ ] Create a new branch on your fork
9+
- [ ] Check your proposed test data follows the [guidelines](https://nf-co.re/docs/contributing/test_data_guidelines)
10+
- [ ] Add your test dataset
11+
- [ ] If you clone it locally use `git clone <url> --branch <branch> --single-branch`
12+
- [ ] Make a PR on a new branch with a relevant name
13+
- [ ] Wait for the PR to be merged
14+
- [ ] Use this newly created branch for your tests

docs/USE_EXISTING_DATA.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
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.
44

5-
- [ ] Check [here](https://github.com/nf-core/test-datasets/branches/all) to find the branch corresponding to the test dataset you want to use (i.e., `modules`, or a given pipeline)
6-
- [ ] Alternatively use nf-core tools to search and explore, e.g. `nf-core test-datasets list` (press tab for options), and then `nf-core test-datasets search -b modules fasta` (press tab for options)
7-
- [ ] You can also use the flag `--generate-nf-path` to generate config ready strings
8-
- [ ] Specify in the `conf/test.config` the path to the files from the test dataset
9-
- [ ] Set up your CI tests following the nf-core best practices
10-
- [ ] For pipelines: [tests/default.nf.test](https://github.com/nf-core/tools/blob/main/nf_core/pipeline-template/tests/default.nf.test))
11-
- [ ] For modules: [tests/main.nf.test](https://github.com/nf-core/tools/blob/main/nf_core/module-template/tests/main.nf.test.j2)
5+
- [ ] Check [here](https://github.com/nf-core/test-datasets/branches/all) to find the branch corresponding to the test dataset you want to use (i.e., `modules`, or a given pipeline)
6+
- [ ] Alternatively use nf-core tools to search and explore, e.g. `nf-core test-datasets list` (press tab for options), and then `nf-core test-datasets search -b modules fasta` (press tab for options)
7+
- [ ] You can also use the flag `--generate-nf-path` to generate config ready strings
8+
- [ ] Specify in the `conf/test.config` the path to the files from the test dataset
9+
- [ ] Set up your CI tests following the nf-core best practices
10+
- [ ] For pipelines: [tests/default.nf.test](https://github.com/nf-core/tools/blob/main/nf_core/pipeline-template/tests/default.nf.test))
11+
- [ ] For modules: [tests/main.nf.test](https://github.com/nf-core/tools/blob/main/nf_core/module-template/tests/main.nf.test.j2)

docs/images/test-datasets_logo.svg

Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)