|
1 | 1 | ---
|
2 | 2 | name: Release checklist
|
3 |
| -about: Checklist before releasing on PyPI and conda-forge |
4 |
| -title: "" |
5 |
| -labels: "" |
| 3 | +about: Checklist and communication channel for PyPI and GitHub release |
| 4 | +title: "Ready for <verison-number> PyPI/GitHub release" |
| 5 | +labels: "release" |
6 | 6 | assignees: ""
|
7 | 7 | ---
|
8 | 8 |
|
9 | 9 | **Release checklist for GitHub contributors**
|
10 | 10 |
|
11 |
| -- [ ] Have you checked that all PRs/issues are resolved for the release version? |
12 |
| -- [ ] Are you using the latest version of [cookiecutter](https://github.com/Billingegroup/cookiecutter)? Ensure `.github/workflows/build-wheel-release-upload.yml` is available. |
13 |
| -- [ ] Have you checked that all the badges on the README are passing? |
14 |
| -- [ ] Have you locally rendered the documentation and confirmed that all pages, including tutorials, are displaying correctly? |
15 |
| -- [ ] Have you checked and updated the installation instructions in the documentation and on the website (e.g., diffpy.org)? |
16 |
| -- [ ] Have you checked for any grammar or typos in the documentation and code? |
17 |
| -- [ ] Have you verified the license information? If you are unsure, please comment below. |
| 11 | +- [ ] All PRs/issues are resolved for the release version. |
| 12 | +- [ ] The latest version of [cookiecutter](https://github.com/Billingegroup/cookiecutter) is used. Ensure `.github/workflows/build-wheel-release-upload.yml` is available. |
| 13 | +- [ ] All the badges on the README are passing. |
| 14 | +- [ ] Locally rendered documentation contains all appropriate pages, including API references, tutorials, and extensions. |
| 15 | +- [ ] Installation instructions in the documentation and on the website (e.g., diffpy.org) are checked and updated. |
| 16 | +- [ ] Grammar and writing quality have been checked. |
| 17 | +- [ ] License information is verified. If you are unsure, please comment below. |
18 | 18 |
|
19 | 19 | Please mention @sbillinge when you are ready for release. Include any additional comments necessary, such as version information and details about the pre-release.
|
0 commit comments