Skip to content

Commit 45a89ec

Browse files
committed
📝 Extend change log title meanings
This patch makes them more verbose so that they are clearer to the readers.
1 parent 0cf92cf commit 45a89ec

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

pyproject.toml

+8-8
Original file line numberDiff line numberDiff line change
@@ -382,50 +382,50 @@ template = "changelog/_template.rst"
382382
# When something public gets removed in a breaking way. Could be
383383
# deprecated in an earlier release.
384384
directory = "breaking"
385-
name = "Breaking Changes"
385+
name = "Removals and backward incompatible breaking changes"
386386
showcontent = true
387387

388388
[[tool.towncrier.type]]
389389
# Declarations of future API removals and breaking changes in behavior.
390390
directory = "deprecation"
391-
name = "Deprecations"
391+
name = "Deprecations (removal in next major release)"
392392
showcontent = true
393393

394394
[[tool.towncrier.type]]
395395
# New behaviors, public APIs. That sort of stuff.
396396
directory = "feature"
397-
name = "Features"
397+
name = "New features"
398398
showcontent = true
399399

400400
[[tool.towncrier.type]]
401401
# New behaviors in existing features.
402402
directory = "improvement"
403-
name = "Improvements"
403+
name = "Improvements in existing functionality"
404404
showcontent = true
405405

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

413413
[[tool.towncrier.type]]
414414
# Updates regarding bundling dependencies.
415415
directory = "vendor"
416-
name = "Vendored Libraries"
416+
name = "Vendored libraries"
417417
showcontent = true
418418

419419
[[tool.towncrier.type]]
420420
# Notable updates to the documentation structure or build process.
421421
directory = "doc"
422-
name = "Improved Documentation"
422+
name = "Improved documentation"
423423
showcontent = true
424424

425425
[[tool.towncrier.type]]
426426
# Changes that might not even be worth exposing to the end users.
427427
directory = "trivial"
428-
name = "Trivial/Internal Changes"
428+
name = "Trivial/internal changes"
429429
showcontent = true
430430

431431
[tool.mypy]

0 commit comments

Comments
 (0)