Skip to content

Commit

Permalink
Merge pull request #1831 from zacharyburnett/docs/pull_request_change…
Browse files Browse the repository at this point in the history
…_types

update change log entry types and add to pull request template
  • Loading branch information
zacharyburnett authored Aug 20, 2024
2 parents e3d708d + e3c0b7a commit 7feeb71
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 2 deletions.
9 changes: 8 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<PR#>.<changetype>.rst`)
- [ ] for a public change, added a [towncrier news fragment](https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments) <details><summary>`changes/<PR#>.<changetype>.rst`</summary>

- ``changes/<PR#>.feature.rst``: new feature
- ``changes/<PR#>.bugfix.rst``: bug fix
- ``changes/<PR#>.doc.rst``: documentation change
- ``changes/<PR#>.removal.rst``: deprecation or removal of public API
- ``changes/<PR#>.general.rst``: infrastructure or miscellaneous change
</details>
- [ ] for a public change, updated documentation
- [ ] for any new features, unit tests were added
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
File renamed without changes.
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -202,3 +202,9 @@ title_format = "{version} ({project_date})"
ignore = [".gitkeep"]
wrap = true
issue_format = "`#{issue} <https://github.com/asdf-format/asdf/pull/{issue}>`_"

[tool.towncrier.fragment.feature]
[tool.towncrier.fragment.bugfix]
[tool.towncrier.fragment.doc]
[tool.towncrier.fragment.removal]
[tool.towncrier.fragment.general]

0 comments on commit 7feeb71

Please sign in to comment.