Skip to content

Commit

Permalink
pybamm-team#2885 Add towncrier configuration file
Browse files Browse the repository at this point in the history
  • Loading branch information
agriyakhetarpal committed Oct 24, 2023
1 parent 1632dc8 commit 9f3331b
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions towncrier.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# towncrier.toml
# A configuration file for towncrier. To customise, browse the configuration reference at
# https://towncrier.readthedocs.io/en/stable/configuration.html

# The following tables for entry types are ordered in the CHANGELOG as they appear below.

[tool.towncrier]
package = "pybamm"
directory = "newsfragments"
filename = "CHANGELOG.md"
underlines = ["", "", ""]
all_bullets = true
title_format = "## [{version}](https://github.com/pybamm-team/PyBaMM/tree/v{version}) - {project_date}"
# Customise the issue format to use pull request numbers instead
issue_format = "[#{issue}](https://github.com/pybamm-team/PyBaMM/pull/{issue})"

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

[[tool.towncrier.type]]
directory = "bugfix"
name = "Bug fixes"
showcontent = true

[[tool.towncrier.type]]
directory = "optimization"
name = "Optimizations"
showcontent = true

[[tool.towncrier.type]]
directory = "breaking"
name = "Breaking changes"
showcontent = true

0 comments on commit 9f3331b

Please sign in to comment.