Skip to content

Commit ab32515

Browse files
committed
Add github pypi release checklist and news
1 parent e64a164 commit ab32515

File tree

3 files changed

+49
-0
lines changed

3 files changed

+49
-0
lines changed
+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: General issue
3+
about: ""
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Release
3+
about: Checklist and communication channel for PyPI and GitHub release
4+
title: "Ready for <version-number> PyPI/GitHub release"
5+
labels: "release"
6+
assignees: ""
7+
---
8+
9+
**Release checklist for GitHub contributors**
10+
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+
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.

news/issue-template.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* Added issue template for PyPI/GitHub release
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)