From 8063f0cb038db80a3dd05dd70e5a50acfe9e5296 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Mon, 9 Sep 2024 08:27:48 -0400 Subject: [PATCH 01/10] Move tests folder to top --- {src/diffpy/snmf/tests => tests}/__init__.py | 0 {src/diffpy/snmf/tests => tests}/conftest.py | 0 {src/diffpy/snmf/tests => tests}/debug.py | 0 {src/diffpy/snmf/tests => tests}/test_containers.py | 0 {src/diffpy/snmf/tests => tests}/test_factorizers.py | 0 {src/diffpy/snmf/tests => tests}/test_optimizers.py | 0 {src/diffpy/snmf/tests => tests}/test_polynomials.py | 0 {src/diffpy/snmf/tests => tests}/test_subroutines.py | 0 8 files changed, 0 insertions(+), 0 deletions(-) rename {src/diffpy/snmf/tests => tests}/__init__.py (100%) rename {src/diffpy/snmf/tests => tests}/conftest.py (100%) rename {src/diffpy/snmf/tests => tests}/debug.py (100%) rename {src/diffpy/snmf/tests => tests}/test_containers.py (100%) rename {src/diffpy/snmf/tests => tests}/test_factorizers.py (100%) rename {src/diffpy/snmf/tests => tests}/test_optimizers.py (100%) rename {src/diffpy/snmf/tests => tests}/test_polynomials.py (100%) rename {src/diffpy/snmf/tests => tests}/test_subroutines.py (100%) diff --git a/src/diffpy/snmf/tests/__init__.py b/tests/__init__.py similarity index 100% rename from src/diffpy/snmf/tests/__init__.py rename to tests/__init__.py diff --git a/src/diffpy/snmf/tests/conftest.py b/tests/conftest.py similarity index 100% rename from src/diffpy/snmf/tests/conftest.py rename to tests/conftest.py diff --git a/src/diffpy/snmf/tests/debug.py b/tests/debug.py similarity index 100% rename from src/diffpy/snmf/tests/debug.py rename to tests/debug.py diff --git a/src/diffpy/snmf/tests/test_containers.py b/tests/test_containers.py similarity index 100% rename from src/diffpy/snmf/tests/test_containers.py rename to tests/test_containers.py diff --git a/src/diffpy/snmf/tests/test_factorizers.py b/tests/test_factorizers.py similarity index 100% rename from src/diffpy/snmf/tests/test_factorizers.py rename to tests/test_factorizers.py diff --git a/src/diffpy/snmf/tests/test_optimizers.py b/tests/test_optimizers.py similarity index 100% rename from src/diffpy/snmf/tests/test_optimizers.py rename to tests/test_optimizers.py diff --git a/src/diffpy/snmf/tests/test_polynomials.py b/tests/test_polynomials.py similarity index 100% rename from src/diffpy/snmf/tests/test_polynomials.py rename to tests/test_polynomials.py diff --git a/src/diffpy/snmf/tests/test_subroutines.py b/tests/test_subroutines.py similarity index 100% rename from src/diffpy/snmf/tests/test_subroutines.py rename to tests/test_subroutines.py From b643887c99a0ef3f79457d6ec3fd0e8cf6b14855 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Mon, 9 Sep 2024 08:38:20 -0400 Subject: [PATCH 02/10] Revert commit --- {tests => src/diffpy/snmf/tests}/__init__.py | 0 {tests => src/diffpy/snmf/tests}/conftest.py | 0 {tests => src/diffpy/snmf/tests}/debug.py | 0 {tests => src/diffpy/snmf/tests}/test_containers.py | 0 {tests => src/diffpy/snmf/tests}/test_factorizers.py | 0 {tests => src/diffpy/snmf/tests}/test_optimizers.py | 0 {tests => src/diffpy/snmf/tests}/test_polynomials.py | 0 {tests => src/diffpy/snmf/tests}/test_subroutines.py | 0 8 files changed, 0 insertions(+), 0 deletions(-) rename {tests => src/diffpy/snmf/tests}/__init__.py (100%) rename {tests => src/diffpy/snmf/tests}/conftest.py (100%) rename {tests => src/diffpy/snmf/tests}/debug.py (100%) rename {tests => src/diffpy/snmf/tests}/test_containers.py (100%) rename {tests => src/diffpy/snmf/tests}/test_factorizers.py (100%) rename {tests => src/diffpy/snmf/tests}/test_optimizers.py (100%) rename {tests => src/diffpy/snmf/tests}/test_polynomials.py (100%) rename {tests => src/diffpy/snmf/tests}/test_subroutines.py (100%) diff --git a/tests/__init__.py b/src/diffpy/snmf/tests/__init__.py similarity index 100% rename from tests/__init__.py rename to src/diffpy/snmf/tests/__init__.py diff --git a/tests/conftest.py b/src/diffpy/snmf/tests/conftest.py similarity index 100% rename from tests/conftest.py rename to src/diffpy/snmf/tests/conftest.py diff --git a/tests/debug.py b/src/diffpy/snmf/tests/debug.py similarity index 100% rename from tests/debug.py rename to src/diffpy/snmf/tests/debug.py diff --git a/tests/test_containers.py b/src/diffpy/snmf/tests/test_containers.py similarity index 100% rename from tests/test_containers.py rename to src/diffpy/snmf/tests/test_containers.py diff --git a/tests/test_factorizers.py b/src/diffpy/snmf/tests/test_factorizers.py similarity index 100% rename from tests/test_factorizers.py rename to src/diffpy/snmf/tests/test_factorizers.py diff --git a/tests/test_optimizers.py b/src/diffpy/snmf/tests/test_optimizers.py similarity index 100% rename from tests/test_optimizers.py rename to src/diffpy/snmf/tests/test_optimizers.py diff --git a/tests/test_polynomials.py b/src/diffpy/snmf/tests/test_polynomials.py similarity index 100% rename from tests/test_polynomials.py rename to src/diffpy/snmf/tests/test_polynomials.py diff --git a/tests/test_subroutines.py b/src/diffpy/snmf/tests/test_subroutines.py similarity index 100% rename from tests/test_subroutines.py rename to src/diffpy/snmf/tests/test_subroutines.py From bd031c1596169b9c4c060af5abd3399685751ee2 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Fri, 18 Oct 2024 12:59:57 -0400 Subject: [PATCH 03/10] Add issue templates for checklist and general issue --- .../workflows/ISSUE_TEMPLATE/general_issue.md | 7 +++++++ .../ISSUE_TEMPLATE/release_checklist.md | 16 ++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 .github/workflows/ISSUE_TEMPLATE/general_issue.md create mode 100644 .github/workflows/ISSUE_TEMPLATE/release_checklist.md diff --git a/.github/workflows/ISSUE_TEMPLATE/general_issue.md b/.github/workflows/ISSUE_TEMPLATE/general_issue.md new file mode 100644 index 00000000..1c05f6bb --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/general_issue.md @@ -0,0 +1,7 @@ +--- +name: General issue +about: "" +title: "" +labels: "" +assignees: "" +--- \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/release_checklist.md b/.github/workflows/ISSUE_TEMPLATE/release_checklist.md new file mode 100644 index 00000000..cba48050 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/release_checklist.md @@ -0,0 +1,16 @@ +--- +name: Release checklist +about: Checklist before releasing on PyPI and conda-forge +title: "" +labels: "" +assignees: "" +--- + +**Release checklist** + +- [ ] Are you using the latest version of [cookiecutter](https://github.com/Billingegroup/cookiecutter)? +- [ ] Are all the badges showing successful status? +- [ ] Have you locally rendered the documentation and confirmed that all pages, including tutorials, are displaying correctly? +- [ ] Have you verified the accuracy of the license information? + +Please mention @sbillinge when you are ready for release. Include any additional comments necessary, such as version information and details about the pre-release. From 13134adf3dde11d2797919e48d043b9b5e4fc3eb Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Fri, 18 Oct 2024 20:04:29 -0400 Subject: [PATCH 04/10] Add release checklist with improved content --- .../ISSUE_TEMPLATE/general_issue.md | 0 .github/ISSUE_TEMPLATE/release_checklist.md | 19 +++++++++++++++++++ .../ISSUE_TEMPLATE/release_checklist.md | 16 ---------------- 3 files changed, 19 insertions(+), 16 deletions(-) rename .github/{workflows => }/ISSUE_TEMPLATE/general_issue.md (100%) create mode 100644 .github/ISSUE_TEMPLATE/release_checklist.md delete mode 100644 .github/workflows/ISSUE_TEMPLATE/release_checklist.md diff --git a/.github/workflows/ISSUE_TEMPLATE/general_issue.md b/.github/ISSUE_TEMPLATE/general_issue.md similarity index 100% rename from .github/workflows/ISSUE_TEMPLATE/general_issue.md rename to .github/ISSUE_TEMPLATE/general_issue.md diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md new file mode 100644 index 00000000..2fc11c45 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -0,0 +1,19 @@ +--- +name: Release checklist +about: Checklist before releasing on PyPI and conda-forge +title: "" +labels: "" +assignees: "" +--- + +**Release checklist for GitHub contributors** + +- [ ] Have you checked that all PRs/issues are resolved for the current version? +- [ ] Are you using the latest version of [cookiecutter](https://github.com/Billingegroup/cookiecutter)? Ensure `.github/workflows/build-wheel-release-upload.yml` is available. +- [ ] Are all the badges on the README showing successful status? +- [ ] Have you locally rendered the documentation and confirmed that all pages, including tutorials, are displaying correctly? +- [ ] Have you checked and updated the installation instructions in the documentation and on the website (e.g., diffpy.org)? +- [ ] Have you checked for any grammar or typos in the documentation and code? +- [ ] Have you verified the license information? 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. \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/release_checklist.md b/.github/workflows/ISSUE_TEMPLATE/release_checklist.md deleted file mode 100644 index cba48050..00000000 --- a/.github/workflows/ISSUE_TEMPLATE/release_checklist.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Release checklist -about: Checklist before releasing on PyPI and conda-forge -title: "" -labels: "" -assignees: "" ---- - -**Release checklist** - -- [ ] Are you using the latest version of [cookiecutter](https://github.com/Billingegroup/cookiecutter)? -- [ ] Are all the badges showing successful status? -- [ ] Have you locally rendered the documentation and confirmed that all pages, including tutorials, are displaying correctly? -- [ ] Have you verified the accuracy of the license information? - -Please mention @sbillinge when you are ready for release. Include any additional comments necessary, such as version information and details about the pre-release. From 3b9e84b0404e47fdf25650b1fa5402071c539388 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Fri, 18 Oct 2024 20:06:51 -0400 Subject: [PATCH 05/10] Improve sentence flow for badges --- .github/ISSUE_TEMPLATE/release_checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 2fc11c45..3427a362 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -8,9 +8,9 @@ assignees: "" **Release checklist for GitHub contributors** -- [ ] Have you checked that all PRs/issues are resolved for the current version? +- [ ] Have you checked that all PRs/issues are resolved for the release version? - [ ] Are you using the latest version of [cookiecutter](https://github.com/Billingegroup/cookiecutter)? Ensure `.github/workflows/build-wheel-release-upload.yml` is available. -- [ ] Are all the badges on the README showing successful status? +- [ ] Have you checked that all the badges on the README are passing? - [ ] Have you locally rendered the documentation and confirmed that all pages, including tutorials, are displaying correctly? - [ ] Have you checked and updated the installation instructions in the documentation and on the website (e.g., diffpy.org)? - [ ] Have you checked for any grammar or typos in the documentation and code? From e9df10c6a16333359af207a137f2f37b5b5e01a4 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Fri, 18 Oct 2024 20:14:20 -0400 Subject: [PATCH 06/10] Turn each bullet into a statement, not questions --- .github/ISSUE_TEMPLATE/release_checklist.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 3427a362..db5b0d47 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -1,19 +1,19 @@ --- name: Release checklist -about: Checklist before releasing on PyPI and conda-forge -title: "" -labels: "" +about: Checklist and communication channel for PyPI and GitHub release +title: "Ready for PyPI/GitHub release" +labels: "release" assignees: "" --- **Release checklist for GitHub contributors** -- [ ] Have you checked that all PRs/issues are resolved for the release version? -- [ ] Are you using the latest version of [cookiecutter](https://github.com/Billingegroup/cookiecutter)? Ensure `.github/workflows/build-wheel-release-upload.yml` is available. -- [ ] Have you checked that all the badges on the README are passing? -- [ ] Have you locally rendered the documentation and confirmed that all pages, including tutorials, are displaying correctly? -- [ ] Have you checked and updated the installation instructions in the documentation and on the website (e.g., diffpy.org)? -- [ ] Have you checked for any grammar or typos in the documentation and code? -- [ ] Have you verified the license information? If you are unsure, please comment below. +- [ ] 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. \ No newline at end of file From 0ea6ce3c40680bb29982495938310e044e55c6d7 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 19 Oct 2024 00:17:02 +0000 Subject: [PATCH 07/10] [pre-commit.ci] auto fixes from pre-commit hooks --- .github/ISSUE_TEMPLATE/general_issue.md | 2 +- .github/ISSUE_TEMPLATE/release_checklist.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/general_issue.md b/.github/ISSUE_TEMPLATE/general_issue.md index 1c05f6bb..4c5da912 100644 --- a/.github/ISSUE_TEMPLATE/general_issue.md +++ b/.github/ISSUE_TEMPLATE/general_issue.md @@ -4,4 +4,4 @@ about: "" title: "" labels: "" assignees: "" ---- \ No newline at end of file +--- diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index db5b0d47..64824df2 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -2,7 +2,7 @@ name: Release checklist about: Checklist and communication channel for PyPI and GitHub release title: "Ready for PyPI/GitHub release" -labels: "release" +labels: "release" assignees: "" --- @@ -16,4 +16,4 @@ assignees: "" - [ ] 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. \ No newline at end of file +Please mention @sbillinge when you are ready for release. Include any additional comments necessary, such as version information and details about the pre-release. From df061ef04502412ad63cf7a80242325e5011e611 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Fri, 18 Oct 2024 20:20:49 -0400 Subject: [PATCH 08/10] Fix typo in title --- .github/ISSUE_TEMPLATE/release_checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index db5b0d47..1f0fc7d3 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -1,7 +1,7 @@ --- -name: Release checklist +name: Release about: Checklist and communication channel for PyPI and GitHub release -title: "Ready for PyPI/GitHub release" +title: "Ready for PyPI/GitHub release" labels: "release" assignees: "" --- From 51b0d91ccea0da94da9ab26b6ae2b1cd00f5046a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 19 Oct 2024 00:21:50 +0000 Subject: [PATCH 09/10] [pre-commit.ci] auto fixes from pre-commit hooks --- .github/ISSUE_TEMPLATE/release_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 936a0aff..f6eb9484 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -2,7 +2,7 @@ name: Release about: Checklist and communication channel for PyPI and GitHub release title: "Ready for PyPI/GitHub release" -labels: "release" +labels: "release" assignees: "" --- From a03c60efe00f2835ba6c500c19495656f392af2a Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Fri, 18 Oct 2024 20:24:05 -0400 Subject: [PATCH 10/10] Add news for issue template --- news/issue-template.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/issue-template.rst diff --git a/news/issue-template.rst b/news/issue-template.rst new file mode 100644 index 00000000..47c1d2a2 --- /dev/null +++ b/news/issue-template.rst @@ -0,0 +1,23 @@ +**Added:** + +* Added issue template for PyPI/GitHub release + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*