README.rst (1662B)
1 This directory contains "newsfragments" which are short files that contain a small **ReST**-formatted 2 text that will be added to the next ``CHANGELOG``. 3 4 The ``CHANGELOG`` will be read by users, so this description should be aimed to pytest users 5 instead of describing internal changes which are only relevant to the developers. 6 7 Make sure to use full sentences with correct case and punctuation, for example:: 8 9 Fix issue with non-ascii messages from the ``warnings`` module. 10 11 Each file should be named like ``<ISSUE>.<TYPE>.rst``, where 12 ``<ISSUE>`` is an issue number, and ``<TYPE>`` is one of: 13 14 * ``feature``: new user facing features, like new command-line options and new behavior. 15 * ``bugfix``: fixes a reported bug. 16 * ``doc``: documentation improvement, like rewording an entire session or adding missing docs. 17 * ``removal``: feature deprecation or removal. 18 * ``vendor``: changes in packages vendored in pytest. 19 * ``trivial``: fixing a small typo or internal change that might be noteworthy. 20 21 So for example: ``123.feature.rst``, ``456.bugfix.rst``. 22 23 If your PR fixes an issue, use that number here. If there is no issue, 24 then after you submit the PR and get the PR number you can add a 25 changelog using that instead. 26 27 If you are not sure what issue type to use, don't hesitate to ask in your PR. 28 29 ``towncrier`` preserves multiple paragraphs and formatting (code blocks, lists, and so on), but for entries 30 other than ``features`` it is usually better to stick to a single paragraph to keep it concise. You can install 31 ``towncrier`` and then run ``towncrier --draft`` 32 if you want to get a preview of how your change will look in the final release notes.