diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index f6eb948..dd45a6f 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -8,12 +8,15 @@ assignees: "" **Release checklist for GitHub contributors** -- [ ] All PRs/issues are resolved for the release version. -- [ ] The latest version of [cookiecutter](https://github.com/Billingegroup/cookiecutter) is used. Ensure `.github/workflows/build-wheel-release-upload.yml` is available. +- [ ] All PRs/issues attached to the release are merged. - [ ] All the badges on the README are passing. -- [ ] Locally rendered documentation contains all appropriate pages, including API references, tutorials, and extensions. -- [ ] Installation instructions in the documentation and on the website (e.g., diffpy.org) are checked and updated. -- [ ] Grammar and writing quality have been checked. -- [ ] License information is verified. If you are unsure, please comment below. +- [ ] License information is verified as correct. If you are unsure, please comment below. +- [ ] Locally rendered documentation contains all appropriate pages, including API references (check no modules are + missing), tutorials, and other human written text is up-to-date with any changes in the code. +- [ ] Installation instructions in the README, documentation and on the website (e.g., diffpy.org) are updated and + tested +- [ ] Successfully run any tutorial examples or do functional testing in some other way. +- [ ] Grammar and writing quality have been checked (no typos). -Please mention @sbillinge when you are ready for release. Include any additional comments necessary, such as version information and details about the pre-release. +Please mention @sbillinge when you are ready for release. Include any additional comments necessary, such as +version information and details about the pre-release.