8000 Add towncrier README and config · matplotlib/matplotlib@f2210cd · GitHub
[go: up one dir, main page]
Skip to content

Commit f2210cd

Browse files
dstansbydstansby
committed
Add towncrier README and config
1 parent e8b40f9 commit f2210cd

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

‎doc/changelog/README.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
:orphan:
2+
3+
Changelog
4+
=========
5+
6+
This directory contains "news fragments" which are short files that contain a
7+
small **ReST**-formatted text that will be added to the next what's new page.
8+
9+
Make sure to use full sentences with correct case and punctuation,
10+
for example::
11+
12+
Add support for Helioprojective coordinates in `sunpy.coordinates.frames`.
13+
14+
Please try to use Sphinx intersphinx using backticks.
15+
16+
Each file should be named lik 8000 e ``<PULL REQUEST>.<TYPE>.rst``, where
17+
``<PULL REQUEST>`` is a pull request number, and ``<TYPE>`` is one of:
18+
19+
* ``api_chage``: A change which requires users to change code and is not
20+
backwards compatible. (Not to be used for removal of deprecated features.)
21+
* ``feature``: New user facing features and any new behavior.
22+
* ``removal``: Removal of a deprecated part of the API.
23+
24+
So for example: ``123.feature.rst``, ``456.bugfix.rst``.
25+
26+
If you are unsure what pull request type to use, don't hesitate to ask in your
27+
PR.
28+
29+
Note that the ``towncrier`` tool will automatically reflow your text, so it
30+
will work best if you stick to a single paragraph, but multiple sentences and
31+
links are OK and encouraged.
32+
33+
You can install ``towncrier`` and then run ``towncrier --draft`` if you want to
34+
get a preview of how your change will look in the final release notes.
35+
36+
.. note::
37+
38+
This README was adapted from the pytest changelog readme under the terms of
39+
the MIT licence.

‎pyproject.toml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
[tool.towncrier]
3+
package = "matplotlib"
4+
filename = "doc/CHANGELOG.rst"
5+
directory = "doc/changelog/"
6+
issue_format = "`#{issue} <https://github.com/matplotlib/matplotlib/pull/{issue}>`__"
7+
8+
[[tool.towncrier.type]]
9+
directory = "api_change"
10+
name = "API changes"
11+
showcontent = true
12+
13+
[[tool.towncrier.type]]
14+
directory = "removal"
15+
name = "Removals"
16+
showcontent = true
17+
18+
[[tool.towncrier.type]]
19+
directory = "feature"
20+
name = "New features"
21+
showcontent = true

0 commit comments

Comments
 (0)
0