test_ok2/changelog/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 with correct case and punctuation, for example::

    Fix issue with non-ascii messages from the ``warnings`` module.

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.
* ``bugfix``: fixes a reported bug.
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
* ``deprecation``: feature deprecation.
* ``removal``: feature removal.
* ``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 install
``towncrier`` and then run ``towncrier --draft``
if you want to get a preview of how your change will look in the final release notes.
Small update to changelog/README.rst 2018-02-17 20:20:41 +08:00			`This directory contains "newsfragments" which are short files that contain a small ReST-formatted`
Add changelog/README.rst and streamline our PR template text This streamlines the PR template text and adds a more in-depth explanation about how the changelog entries work because this topic is a common source of confusion: - How to name the files. - Which formatting to use (people in general assume it is Markdown). - Recommend adding `.rst` extension to changelog files to help with the above (`towncrier` doesn't care). This was heavily inspired by the excellent python-trio/trio docs. 2018-02-07 08:13:04 +08:00			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.`

apply most other hooks and opt out of black reformating 2018-05-18 16:19:46 +08:00			`Make sure to use full sentences with correct case and punctuation, for example::`
Small update to changelog/README.rst 2018-02-17 20:20:41 +08:00
			Fix issue with non-ascii messages from the ``warnings`` module.
Add changelog/README.rst and streamline our PR template text This streamlines the PR template text and adds a more in-depth explanation about how the changelog entries work because this topic is a common source of confusion: - How to name the files. - Which formatting to use (people in general assume it is Markdown). - Recommend adding `.rst` extension to changelog files to help with the above (`towncrier` doesn't care). This was heavily inspired by the excellent python-trio/trio docs. 2018-02-07 08:13:04 +08:00
			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.
			* ``bugfix``: fixes a reported bug.
			* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
Separate deprecations and removals in the CHANGELOG 2018-09-14 01:02:01 +08:00			* ``deprecation``: feature deprecation.
			* ``removal``: feature removal.
Code review suggestions 2018-02-08 18:03:14 +08:00			* ``vendor``: changes in packages vendored in pytest.
Add changelog/README.rst and streamline our PR template text This streamlines the PR template text and adds a more in-depth explanation about how the changelog entries work because this topic is a common source of confusion: - How to name the files. - Which formatting to use (people in general assume it is Markdown). - Recommend adding `.rst` extension to changelog files to help with the above (`towncrier` doesn't care). This was heavily inspired by the excellent python-trio/trio docs. 2018-02-07 08:13:04 +08:00			* ``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.`

Update README for CHANGELOG about using multiple paragraphs 2018-07-07 22:07:13 +08:00			``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 install
			``towncrier`` and then run ``towncrier --draft``
Add changelog/README.rst and streamline our PR template text This streamlines the PR template text and adds a more in-depth explanation about how the changelog entries work because this topic is a common source of confusion: - How to name the files. - Which formatting to use (people in general assume it is Markdown). - Recommend adding `.rst` extension to changelog files to help with the above (`towncrier` doesn't care). This was heavily inspired by the excellent python-trio/trio docs. 2018-02-07 08:13:04 +08:00			`if you want to get a preview of how your change will look in the final release notes.`