Skip to content

Commit

Permalink
📝 Extend change log title meanings
Browse files Browse the repository at this point in the history
This patch makes them more verbose so that they are clearer to the
readers.
  • Loading branch information
webknjaz committed Jun 20, 2024
1 parent 9864115 commit c0ff4a7
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -373,50 +373,50 @@ template = "changelog/_template.rst"
# When something public gets removed in a breaking way. Could be
# deprecated in an earlier release.
directory = "breaking"
name = "Breaking Changes"
name = "Removals and backward incompatible breaking changes"
showcontent = true

[[tool.towncrier.type]]
# Declarations of future API removals and breaking changes in behavior.
directory = "deprecation"
name = "Deprecations"
name = "Deprecations (removal in next major release)"
showcontent = true

[[tool.towncrier.type]]
# New behaviors, public APIs. That sort of stuff.
directory = "feature"
name = "Features"
name = "New features"
showcontent = true

[[tool.towncrier.type]]
# New behaviors in existing features.
directory = "improvement"
name = "Improvements"
name = "Improvements in existing functionality"
showcontent = true

[[tool.towncrier.type]]
# Something we deemed an improper undesired behavior that got corrected
# in the release to match pre-agreed expectations.
directory = "bugfix"
name = "Bug Fixes"
name = "Bug fixes"
showcontent = true

[[tool.towncrier.type]]
# Updates regarding bundling dependencies.
directory = "vendor"
name = "Vendored Libraries"
name = "Vendored libraries"
showcontent = true

[[tool.towncrier.type]]
# Notable updates to the documentation structure or build process.
directory = "doc"
name = "Improved Documentation"
name = "Improved documentation"
showcontent = true

[[tool.towncrier.type]]
# Changes that might not even be worth exposing to the end users.
directory = "trivial"
name = "Trivial/Internal Changes"
name = "Trivial/internal changes"
showcontent = true

[tool.mypy]
Expand Down

0 comments on commit c0ff4a7

Please sign in to comment.