74c986e53b
|
||
|---|---|---|
| .. | ||
| .gitignore | ||
| 2549.feature.rst | ||
| 2594.feature.rst | ||
| 2596.feature.rst | ||
| 2597.doc.rst | ||
| 2614.bugfix.rst | ||
| 2618.bugfix.rst | ||
| 2624.feature.rst | ||
| 2626.bugfix.rst | ||
| 2628.misc.rst | ||
| 2629.misc.rst | ||
| 2637.bugfix.rst | ||
| README.md | ||
| validate_files.py | ||
README.md
This directory collects "newsfragments": short files that each contain a snippet of ReST-formatted text that will be added to the next release notes. This should be a description of aspects of the change (if any) that are relevant to users. (This contrasts with the commit message and PR description, which are a description of the change as relevant to people working on the code itself.)
The pull request (PR) number should be used for the newsfragment file. Each file
should be named <PR_NUMBER>.<TYPE>.rst, where <TYPE> is one of:
featurebugfixdocmisc
For example: 123.feature.rst, 456.bugfix.rst
Along with the required PR newsfragment file (enforced by a GitHub Action),
additional newsfragment files for issues linked to the PR can optionally be
included by following the same naming convention above, and
using <ISSUE_NUMBER> instead of <PR_NUMBER>.
Note that the towncrier tool will automatically
reflow your text, so don't try to do any fancy formatting. Run
towncrier --draft to get a preview of what the release notes entry
will look like in the final release notes.