From 83f5e750595a8014708aaa9622a017786c004ae4 Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Tue, 20 Aug 2024 10:08:41 -0400 Subject: [PATCH 1/5] update pull request template to include collapsed explanation of change log entry types --- .github/pull_request_template.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 32be9e07f..3fed6d259 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -29,6 +29,13 @@ If this PR fixes an issue, please add closing keywords (eg 'fixes #XXX') - [ ] pre-commit checks ran successfully - [ ] tests ran successfully -- [ ] for a public change, added news fragment (`changes/..rst`) +- [ ] for a public change, added
news fragment (`changes/..rst`) + + - ``changes/.feature.rst``: new feature + - ``changes/.bugfix.rst``: bug fix + - ``changes/.doc.rst``: documentation change + - ``changes/.removal.rst``: deprecation or removal of public API + - ``changes/.misc.rst``: not of interest to users; use an empty file +
- [ ] for a public change, updated documentation - [ ] for any new features, unit tests were added From 7cc9c59577ef8823c423d761af8488d3076bd1ab Mon Sep 17 00:00:00 2001 From: Zach Burnett Date: Tue, 20 Aug 2024 10:29:10 -0400 Subject: [PATCH 2/5] add link to towncrier docs Co-authored-by: Brett Graham --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3fed6d259..32d22d35c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -29,7 +29,7 @@ If this PR fixes an issue, please add closing keywords (eg 'fixes #XXX') - [ ] pre-commit checks ran successfully - [ ] tests ran successfully -- [ ] for a public change, added
news fragment (`changes/..rst`) +- [ ] for a public change, added a [towncrier](https://towncrier.readthedocs.io/en/stable/)
news fragment (`changes/..rst`) - ``changes/.feature.rst``: new feature - ``changes/.bugfix.rst``: bug fix From 7b3b5ab76d57e3a2dabffbd0722602f0c65bee8e Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Tue, 20 Aug 2024 10:33:01 -0400 Subject: [PATCH 3/5] change link to docs --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 32d22d35c..959daf732 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -29,7 +29,7 @@ If this PR fixes an issue, please add closing keywords (eg 'fixes #XXX') - [ ] pre-commit checks ran successfully - [ ] tests ran successfully -- [ ] for a public change, added a [towncrier](https://towncrier.readthedocs.io/en/stable/)
news fragment (`changes/..rst`) +- [ ] for a public change, added a [towncrier news fragment](https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments)
`changes/..rst` - ``changes/.feature.rst``: new feature - ``changes/.bugfix.rst``: bug fix From bef0ebd5a31827f268855c2da3e23405c9a2d057 Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Tue, 20 Aug 2024 10:33:37 -0400 Subject: [PATCH 4/5] explicitly define change types --- .github/pull_request_template.md | 2 +- CONTRIBUTING.rst | 2 +- pyproject.toml | 6 ++++++ 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 959daf732..89b2d33d8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -35,7 +35,7 @@ If this PR fixes an issue, please add closing keywords (eg 'fixes #XXX') - ``changes/.bugfix.rst``: bug fix - ``changes/.doc.rst``: documentation change - ``changes/.removal.rst``: deprecation or removal of public API - - ``changes/.misc.rst``: not of interest to users; use an empty file + - ``changes/.general.rst``: infrastructure or miscellaneous change
- [ ] for a public change, updated documentation - [ ] for any new features, unit tests were added diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c623fc53d..1ac4295a4 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -62,4 +62,4 @@ to the maintainers, who are glad to assist you. - ``bugfix``: bug fix - ``doc``: documentation change - ``removal``: deprecation or removal of public API - - ``misc``: not of interest to users + - ``general``: infrastructure or miscellaneous change diff --git a/pyproject.toml b/pyproject.toml index 2d1ca65c7..ab60b4057 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -202,3 +202,9 @@ title_format = "{version} ({project_date})" ignore = [".gitkeep"] wrap = true issue_format = "`#{issue} `_" + +[tool.towncrier.fragment.feature] +[tool.towncrier.fragment.bugfix] +[tool.towncrier.fragment.doc] +[tool.towncrier.fragment.removal] +[tool.towncrier.fragment.general] From e3c0b7aee63e60c791ee7b37ca6720d3005e23d8 Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Tue, 20 Aug 2024 10:41:09 -0400 Subject: [PATCH 5/5] move misc to general --- changes/{1828.misc.rst => 1828.general.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename changes/{1828.misc.rst => 1828.general.rst} (100%) diff --git a/changes/1828.misc.rst b/changes/1828.general.rst similarity index 100% rename from changes/1828.misc.rst rename to changes/1828.general.rst