test_ok2/changelog
Ran Benita b26d1bb18f cacheprovider: add cache.mkdir() as a Path-returning replacement to makedir()
It is not possible to change a return type in a compatible way, so a new
method is added.
2021-03-15 10:39:31 +02:00
..
5105.doc.rst Added how-to and reference directories. 2021-03-11 22:13:01 +00:00
7259.feature.rst cacheprovider: add cache.mkdir() as a Path-returning replacement to makedir() 2021-03-15 10:39:31 +02:00
7469.deprecation.rst code: export ExceptionInfo for typing purposes 2021-03-13 15:59:44 +02:00
7469.feature.rst code: export ExceptionInfo for typing purposes 2021-03-13 15:59:44 +02:00
8061.bugfix.rst Fix failing staticmethod tests if they are inherited (#8205) 2020-12-30 19:00:37 -08:00
8144.feature.rst hookspec: add pathlib.Path alternatives to py.path.local parameters in hooks 2020-12-15 00:34:23 +02:00
8174.trivial.rst Convert most of the collection code from py.path to pathlib 2020-12-22 21:09:36 +02:00
8192.bugfix.rst changelog: fix missing tick 2021-01-29 16:06:36 +02:00
8242.deprecation.rst Deprecate raising unittest.SkipTest to skip tests during collection 2021-01-15 00:05:33 +02:00
8248.trivial.rst alter the PyObjMixin to carry over typing information from Node 2021-01-17 14:36:28 +01:00
8251.deprecation.rst implement Node.path as pathlib.Path 2021-03-06 21:32:03 +01:00
8251.feature.rst implement Node.path as pathlib.Path 2021-03-06 21:32:03 +01:00
8258.bugfix.rst Always handle faulthandler stderr even if already enabled 2021-01-20 10:29:05 -03:00
8315.deprecation.rst config/argparsing: use proper deprecations instead of ad-hoc DeprecationWarning 2021-02-05 00:05:47 +02:00
8317.bugfix.rst Fixed an issue where `getpass.getuser()` contained illegal characters for file directories (#8365) 2021-02-25 08:28:57 +00:00
8367.bugfix.rst Allow Class.from_parent to forward custom parameters to the constructor 2021-02-23 18:00:56 +01:00
8384.bugfix.rst Fix skip signature (#8392) 2021-03-04 11:56:21 +01:00
8394.bugfix.rst Merge pull request #8399 from atzannes/master 2021-03-04 22:45:57 +02:00
8411.trivial.rst fix bug in test for issue 519 2021-03-07 15:01:39 +01:00
8421.feature.rst Approx decimal sequence mapping (#8422) 2021-03-13 16:01:23 +02:00
README.rst docs: use doc/en/_build/html for html output (#6842) 2020-02-29 00:47:30 +01:00
_template.rst Update CHANGELOG template to put issue links at the start of entries 2018-07-07 11:02:33 -03:00

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.