diff --git a/.github/ISSUE_TEMPLATE/general_issue.md b/.github/ISSUE_TEMPLATE/general_issue.md new file mode 100644 index 0000000..4c5da91 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general_issue.md @@ -0,0 +1,7 @@ +--- +name: General issue +about: "" +title: "" +labels: "" +assignees: "" +--- diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md new file mode 100644 index 0000000..f6eb948 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -0,0 +1,19 @@ +--- +name: Release +about: Checklist and communication channel for PyPI and GitHub release +title: "Ready for PyPI/GitHub release" +labels: "release" +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 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. + +Please mention @sbillinge when you are ready for release. Include any additional comments necessary, such as version information and details about the pre-release. diff --git a/news/issue-template.rst b/news/issue-template.rst new file mode 100644 index 0000000..47c1d2a --- /dev/null +++ b/news/issue-template.rst @@ -0,0 +1,23 @@ +**Added:** + +* Added issue template for PyPI/GitHub release + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*