f9afcd2d8a
* Remove changelog entry for #8251 Reverted in #8903 * Move #9202 changelog to to trivial This won't concern users of pytest * Streamline deprecation changelogs/docs * Remove #8994 changelog This is an impovement for a warning introduced in this release, so including it in a changelog against the last release seems confusing. * Remove #9241 changelog This is an impovement for a doc update introduced in this release, so including it in a changelog against the last release seems confusing. The issue number also seems about something different. * Remove #8897 changelog Empty file... * Various minor changelog fixes |
||
|---|---|---|
| .. | ||
| 4320.doc.rst | ||
| 5105.doc.rst | ||
| 5196.feature.rst | ||
| 7124.bugfix.rst | ||
| 7132.feature.rst | ||
| 7259.breaking.rst | ||
| 7259.deprecation.rst | ||
| 7259.feature.rst | ||
| 7469.deprecation.rst | ||
| 7469.feature.rst | ||
| 7856.feature.rst | ||
| 7864.improvement.rst | ||
| 8061.bugfix.rst | ||
| 8133.trivial.rst | ||
| 8144.feature.rst | ||
| 8174.trivial.rst | ||
| 8192.bugfix.rst | ||
| 8242.deprecation.rst | ||
| 8246.breaking.rst | ||
| 8248.trivial.rst | ||
| 8251.feature.rst | ||
| 8258.bugfix.rst | ||
| 8315.deprecation.rst | ||
| 8317.bugfix.rst | ||
| 8335.improvement.rst | ||
| 8337.doc.rst | ||
| 8367.bugfix.rst | ||
| 8377.bugfix.rst | ||
| 8384.bugfix.rst | ||
| 8394.bugfix.rst | ||
| 8403.improvement.rst | ||
| 8421.feature.rst | ||
| 8432.trivial.rst | ||
| 8447.deprecation.rst | ||
| 8456.bugfix.rst | ||
| 8464.bugfix.rst | ||
| 8503.bugfix.rst | ||
| 8509.improvement.rst | ||
| 8548.bugfix.rst | ||
| 8592.deprecation.rst | ||
| 8606.feature.rst | ||
| 8645.deprecation.rst | ||
| 8655.doc.rst | ||
| 8761.feature.rst | ||
| 8789.feature.rst | ||
| 8796.bugfix.rst | ||
| 8803.improvement.rst | ||
| 8818.trivial.rst | ||
| 8898.improvement.rst | ||
| 8913.trivial.rst | ||
| 8920.feature.rst | ||
| 8948.deprecation.rst | ||
| 8953.feature.rst | ||
| 8954.feature.rst | ||
| 8967.trivial.rst | ||
| 8983.bugfix.rst | ||
| 8990.bugfix.rst | ||
| 9023.feature.rst | ||
| 9061.breaking.rst | ||
| 9062.improvement.rst | ||
| 9077.bugfix.rst | ||
| 9113.feature.rst | ||
| 9114.feature.rst | ||
| 9131.bugfix.rst | ||
| 9163.bugfix.rst | ||
| 9169.bugfix.rst | ||
| 9202.trivial.rst | ||
| 9205.improvement.rst | ||
| 9210.doc.rst | ||
| 9225.trivial.rst | ||
| 9242.doc.rst | ||
| 9272.bugfix.rst | ||
| README.rst | ||
| _template.rst | ||
README.rst
This directory contains "newsfragments" which are short files that contain a small **ReST**-formatted
text that will be added to the next ``CHANGELOG``.
The ``CHANGELOG`` will be read by **users**, so this description should be aimed to pytest users
instead of describing internal changes which are only relevant to the developers.
Make sure to use full sentences in the **past or present tense** and use punctuation, examples::
Improved verbose diff output with sequences.
Terminal summary statistics now use multiple colors.
Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
``<ISSUE>`` is an issue number, and ``<TYPE>`` is one of:
* ``feature``: new user facing features, like new command-line options and new behavior.
* ``improvement``: improvement of existing functionality, usually without requiring user intervention (for example, new fields being written in ``--junitxml``, improved colors in terminal, etc).
* ``bugfix``: fixes a bug.
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
* ``deprecation``: feature deprecation.
* ``breaking``: a change which may break existing suites, such as feature removal or behavior change.
* ``vendor``: changes in packages vendored in pytest.
* ``trivial``: fixing a small typo or internal change that might be noteworthy.
So for example: ``123.feature.rst``, ``456.bugfix.rst``.
If your PR fixes an issue, use that number here. If there is no issue,
then after you submit the PR and get the PR number you can add a
changelog using that instead.
If you are not sure what issue type to use, don't hesitate to ask in your PR.
``towncrier`` preserves multiple paragraphs and formatting (code blocks, lists, and so on), but for entries
other than ``features`` it is usually better to stick to a single paragraph to keep it concise.
You can also run ``tox -e docs`` to build the documentation
with the draft changelog (``doc/en/_build/html/changelog.html``) if you want to get a preview of how your change will look in the final release notes.