diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7dd83390..d076b2de 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,8 +8,19 @@ Closes # This PR addresses ... -**Checklist** -- [ ] Added entry in `CHANGES.rst` under the corresponding subsection -- [ ] updated relevant tests -- [ ] updated relevant documentation -- [ ] Passed romancal regression testing on Jenkins / PLWishMaster. Link: https://plwishmaster.stsci.edu:8081/job/RT/job/romancal/XXX/ + +## Tasks +- [ ] update or add relevant tests +- [ ] update relevant docstrings and / or `docs/` page +- [ ] Does this PR change any API used downstream? (if not, label with `no-changelog-entry-needed`) + - [ ] write news fragment(s) in `changes/`: `echo "changed something" > changes/..rst` (see below for change types) + - [ ] [start a `romancal` regression test](https://github.com/spacetelescope/RegressionTests/actions/workflows/romancal.yml) with this branch installed (`"git+https://github.com//roman_datamodels@"`) + +
news fragment change types... + +- ``changes/.feature.rst``: new feature +- ``changes/.bugfix.rst``: fixes an issue +- ``changes/.doc.rst``: documentation change +- ``changes/.removal.rst``: deprecation or removal of public API +- ``changes/.misc.rst``: infrastructure or miscellaneous change +
1.2.0 + - towncrier diff --git a/pyproject.toml b/pyproject.toml index 1cb8f94c..bd5f8241 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -114,3 +114,26 @@ line-length = 130 [tool.codespell] skip = "*.pdf,*.fits,*.asdf,.tox,build,./tags,.git,docs/_build" + +[tool.towncrier] +filename = "CHANGES.rst" +directory = "changes" +package = "roman_datamodels" +title_format = "{version} ({project_date})" +ignore = [".gitkeep"] +wrap = true +issue_format = "`#{issue} `_" + +[tool.towncrier.fragment.feature] +name = "New Features" + +[tool.towncrier.fragment.bugfix] +name = "Bug Fixes" + +[tool.towncrier.fragment.doc] +name = "Documentation" + +[tool.towncrier.fragment.removal] +name = "Deprecations and Removals" + +[tool.towncrier.fragment.misc]