Skip to content

Commit

Permalink
Added change categories
Browse files Browse the repository at this point in the history
  • Loading branch information
kc611 committed Mar 9, 2023
1 parent b2974ea commit 649f513
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 36 deletions.
27 changes: 0 additions & 27 deletions docs/source/release/template.rst

This file was deleted.

23 changes: 14 additions & 9 deletions docs/source/upcoming_changes/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,20 @@ your user-facing changes as they should appear in the relase notes.
Each file should be named like ``<PULL REQUEST>.<TYPE>.rst``, where
``<PULL REQUEST>`` is a pull request number, and ``<TYPE>`` is one of:

* ``feature``: Signifying a new feature.

* ``bugfix``: Signifying a bug fix.

* ``doc``: Signifying a documentation improvement.

* ``removal``: Signifying a deprecation or removal of public API.

* ``misc``: A ticket has been closed, but it is not of interest to users.
* ``highlight``: Adds a highlight bullet point to use as a possibly highlight
of the release.
* ``np_support``: Addition of new NumPy functionality.
* ``deprecation``: Changes existing code to emit a DeprecationWarning.
* ``future``: Changes existing code to emit a FutureWarning.
* ``expired``: Removal of a deprecated part of the API.
* ``compatibility``: A change which requires users to change code and is not
backwards compatible. (Not to be used for removal of deprecated features.)
* ``cuda``: Changes in the CUDA API.
* ``new_feature``: New user facing features like ``kwargs``.
* ``improvement``: General improvements and edge-case changes which are
not new features or compatibility related.
* ``performance``: Performance changes that should not affect other behaviour.
* ``change``: Other changes

If you are unsure what pull request type to use, don't hesitate to ask in your
PR.
Expand Down
55 changes: 55 additions & 0 deletions towncrier.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,58 @@ package = "numba"

directory = "docs/source/upcoming_changes"
filename = "docs/source/release/{version}-notes.rst"

[[tool.towncrier.type]]
directory = "highlight"
name = "Highlights"
showcontent = true

[[tool.towncrier.type]]
directory = "np_support"
name = "NumPy support"
showcontent = true

[[tool.towncrier.type]]
directory = "deprecation"
name = "Deprecations"
showcontent = true

[[tool.towncrier.type]]
directory = "future"
name = "Future Changes"
showcontent = true

[[tool.towncrier.type]]
directory = "expired"
name = "Expired deprecations"
showcontent = true

[[tool.towncrier.type]]
directory = "compatibility"
name = "Compatibility notes"
showcontent = true

[[tool.towncrier.type]]
directory = "cuda"
name = "CUDA API changes"
showcontent = true

[[tool.towncrier.type]]
directory = "new_feature"
name = "New Features"
showcontent = true

[[tool.towncrier.type]]
directory = "improvement"
name = "Improvements"
showcontent = true

[[tool.towncrier.type]]
directory = "performance"
name = "Performance improvements and changes"
showcontent = true

[[tool.towncrier.type]]
directory = "change"
name = "Changes"
showcontent = true

0 comments on commit 649f513

Please sign in to comment.