diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index edd7cdb8..1c1e7da0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,4 @@ + + ## PR Checklist for a new package submission @@ -25,10 +25,10 @@ Please ensure you are completing all the TODOs below. *** - [ ] The package is complete and features the following elements: - - [ ] Genotype data in binary PLINK format. - - [ ] A `POSEIDON.yml` file with all of the following non-file reference fields present and filled with meaningful information: `poseidonVersion`, `title`, `description`, `contributor`, `packageVersion`, `lastModified` (see [here](https://github.com/poseidon-framework/poseidon-schema/blob/master/POSEIDON_yml_fields.tsv) for their definition) - - [ ] A reasonably filled `.janno` file. - - [ ] A `.bib` file with references for each sample in the `.janno` file. + - [ ] Genotype data in binary PLINK format (not EIGENSTRAT format). + - [ ] A `POSEIDON.yml` file with not just the file-referencing fields, but also the following meta-information fields present and filled: `poseidonVersion`, `title`, `description`, `contributor`, `packageVersion`, `lastModified` (see [here](https://github.com/poseidon-framework/poseidon-schema/blob/master/POSEIDON_yml_fields.tsv) for their definition) + - [ ] A reasonably filled `.janno` file (for a list of available fields look [here](https://github.com/poseidon-framework/poseidon-schema/blob/master/janno_columns.tsv) and [here](https://www.poseidon-adna.org/#/janno_details) for more detailed documentation about them). + - [ ] A `.bib` file with the necessary literature references for each sample in the `.janno` file. - [ ] Every file in the submission is correctly referenced in the `POSEIDON.yml` file and there are no additional, supplementary files in the submission that are not documented there. - [ ] Genotype data, `.janno` and `.bib` file are all named after the package title and only differ in the file extension. - [ ] All text files are UTF-8 encoded and have Unix/Unix-like line endings (`LF`, not `CR+LF` or `CR`). @@ -46,6 +46,8 @@ Please ensure you are completing all the TODOs below. - [ ] The package passes a validation with `trident validate --fullGeno`. + + ## PR Checklist for modifying one or multiple existing packages @@ -65,5 +67,3 @@ Please ensure you are completing all the TODOs below. *** - [ ] All affected packages pass a validation with `trident validate --fullGeno`. - - \ No newline at end of file