Skip to content

Commit 3e60664

Browse files
Update dataset-addition.md
1 parent 07a1d9a commit 3e60664

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

.github/ISSUE_TEMPLATE/dataset-addition.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,21 @@ assignees: ''
1616

1717
<links including data websites, repositories, papers, etc. that would help in adding the dataset.>
1818

19-
**Dataset ID(s):**
20-
21-
<propose dataset ID(s), and where they fit in the hierarchy>
22-
23-
**Supported Entities**
24-
25-
- [] docs
26-
- [] queries
27-
- [] qrels
28-
- [] scoreddocs
29-
- [] docpairs
30-
19+
**Dataset ID(s) & supported entities:**
20+
21+
- <propose dataset ID(s), and where they fit in the hierarchy, and specify which entity types each will provide (docs, queries, qrels, scoreddocs, docpairs, qlogs)>
22+
23+
**Checklist**
24+
25+
Mark each task once completed. All should be checked prior to merging a new dataset.
26+
27+
- [ ] Dataset definition (in `ir_datasets/datasets/[topid].py`)
28+
- [ ] Tests (in `tests/integration/[topid].py`)
29+
- [ ] Metadata generated (using `ir_datasets generate_metadata` command, should appear in `ir_datasets/etc/metadata.json`)
30+
- [ ] Documentation (in `ir_datasets/etc/[topid].yaml`)
31+
- [ ] Documentation generated in https://github.com/seanmacavaney/ir-datasets.com/
32+
- [ ] Downloadable content (in `ir_datasets/etc/downloads.json`)
33+
- [ ] Download verification action (in `.github/workflows/verify_downloads.yml`). Only one needed per `topid`.
34+
- [ ] Any small public files from NIST (or other potentially troublesome files) mirrored in https://github.com/seanmacavaney/irds-mirror/. Mirrored status properly reflected in `downloads.json`.
35+
3136
**Additional comments/concerns/ideas/etc.**

0 commit comments

Comments
 (0)