📝 Extend change log title meanings
This patch makes them more verbose so that they are clearer to the readers.
This commit is contained in:
parent
0cf92cfa4c
commit
45a89ec61f
|
@ -382,50 +382,50 @@ template = "changelog/_template.rst"
|
||||||
# When something public gets removed in a breaking way. Could be
|
# When something public gets removed in a breaking way. Could be
|
||||||
# deprecated in an earlier release.
|
# deprecated in an earlier release.
|
||||||
directory = "breaking"
|
directory = "breaking"
|
||||||
name = "Breaking Changes"
|
name = "Removals and backward incompatible breaking changes"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
# Declarations of future API removals and breaking changes in behavior.
|
# Declarations of future API removals and breaking changes in behavior.
|
||||||
directory = "deprecation"
|
directory = "deprecation"
|
||||||
name = "Deprecations"
|
name = "Deprecations (removal in next major release)"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
# New behaviors, public APIs. That sort of stuff.
|
# New behaviors, public APIs. That sort of stuff.
|
||||||
directory = "feature"
|
directory = "feature"
|
||||||
name = "Features"
|
name = "New features"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
# New behaviors in existing features.
|
# New behaviors in existing features.
|
||||||
directory = "improvement"
|
directory = "improvement"
|
||||||
name = "Improvements"
|
name = "Improvements in existing functionality"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
# Something we deemed an improper undesired behavior that got corrected
|
# Something we deemed an improper undesired behavior that got corrected
|
||||||
# in the release to match pre-agreed expectations.
|
# in the release to match pre-agreed expectations.
|
||||||
directory = "bugfix"
|
directory = "bugfix"
|
||||||
name = "Bug Fixes"
|
name = "Bug fixes"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
# Updates regarding bundling dependencies.
|
# Updates regarding bundling dependencies.
|
||||||
directory = "vendor"
|
directory = "vendor"
|
||||||
name = "Vendored Libraries"
|
name = "Vendored libraries"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
# Notable updates to the documentation structure or build process.
|
# Notable updates to the documentation structure or build process.
|
||||||
directory = "doc"
|
directory = "doc"
|
||||||
name = "Improved Documentation"
|
name = "Improved documentation"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
# Changes that might not even be worth exposing to the end users.
|
# Changes that might not even be worth exposing to the end users.
|
||||||
directory = "trivial"
|
directory = "trivial"
|
||||||
name = "Trivial/Internal Changes"
|
name = "Trivial/internal changes"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[tool.mypy]
|
[tool.mypy]
|
||||||
|
|
Loading…
Reference in New Issue