Merge pull request #211 from alexdaniel654/maintenance/pr_templates

Update PR Templates

.github/CONTRIBUTING.md

@@ -5,7 +5,7 @@
 - Ensure code follows [PEP8](https://www.python.org/dev/peps/pep-0008/).
 - Provide tests.
 - Ideally, provide examples and/or tutorials.
-- Make sure you follow the checklists on the [pull request template](PULL_REQUEST_TEMPLATE.md)
+- Make sure you follow the checklists on the [pull request template](PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md)
 - Branch off and request merges to the `dev` branch
 
 # Workflow

.github/PULL_REQUEST_TEMPLATE/NEW_RELEASE_TEMPLATE.md

@@ -0,0 +1,20 @@
+## Release Checklist
+
+### Pull Request
+- [ ] Branch is from `dev` to `rel/v[x.y.z]`
+- [ ] Update the [`CHANGELOG.md`](https://github.com/UKRIN-MAPS/ukat/blob/master/CHANGELOG.md) file with the new version number, release date and add the new features/fixes along with any tags of PRs/issues
+- [ ] Bump the version number in [`setup.py`](https://github.com/UKRIN-MAPS/ukat/blob/master/setup.py)
+- [ ] Add any new contributors and bump the version number in [`CITATION.cff`](https://github.com/UKRIN-MAPS/ukat/blob/master/CITATION.cff)
+- [ ] Do a final check if anything in [readme.MD](rhttps://github.com/UKRIN-MAPS/ukat/blob/master/README.md) needs updating
+- [ ] The pull requests is from `rel/v[x.y.z]` to `master`
+- [ ] All tests pass
+- [ ] Merge `rel/v[x.y.z]` into `master`
+- [ ] Merge `rel/v[x.y.z]` into `dev`
+- [ ] Create a tag on the merge commit on master with the same version number as the release and push to upstream
+
+### Post Pull Request Checks
+- [ ] Close any issues from the milestone that didn't automatically close on merge
+- [ ] Close the milestone itself
+- [ ] Check the new version has appeared in the [releases list](https://github.com/UKRIN-MAPS/ukat/releases)
+- [ ] Check the new version has appeared on [PyPI](https://pypi.org/project/ukat/)
+- [ ] Check a now DOI has been minted on [Zenodo](https://zenodo.org/account/settings/github/repository/UKRIN-MAPS/ukat)

.github/PULL_REQUEST_TEMPLATE.md → .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md

@@ -6,11 +6,14 @@ Describe the big picture of your changes here to communicate to the maintainers
 
 - [ ] I have read and followed the [CONTRIBUTING](.github/CONTRIBUTING.md) document
 - [ ] This pull request is from and to the dev branch
+- [ ] I have added tests that demonstrate the feature/fix works
 - [ ] I have added necessary documentation (if appropriate)
 - [ ] I have updated documentation which becomes obsolete after my changes (if appropriate)
+- [ ] I have added/updated a notebook to demonstrate the changes (if appropriate)
 - [ ] Files added follow the repository structure (if appropriate)
 
 If adding test data?
 - [ ] Data is anonymised
 - [ ] Ensure imaging data is in NIfTI format and was converted using [`d2n`](https://github.com/UKRIN-MAPS/d2n)
-- [ ] Update the [`data/README.md`](data/README.md) file with info about the origin of the data
+- [ ] Update the [`data/README.md`](data/README.md) file in both `ukat/data/` and `ukat/data/contrast` with info about the origin of the data
+- [ ] Added tests for the new functions in `data.fetch.py`