From f56cff113fde57f49d2eb7f1f16e499916943554 Mon Sep 17 00:00:00 2001 From: Eric Prestat Date: Tue, 13 Feb 2024 17:23:54 +0000 Subject: [PATCH] Add changelog entry --- upcoming_changes/27.maintenance.rst | 1 + upcoming_changes/README.rst | 36 +++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 upcoming_changes/27.maintenance.rst create mode 100644 upcoming_changes/README.rst diff --git a/upcoming_changes/27.maintenance.rst b/upcoming_changes/27.maintenance.rst new file mode 100644 index 000000000..0100d9cdf --- /dev/null +++ b/upcoming_changes/27.maintenance.rst @@ -0,0 +1 @@ +Use `ruff `_ for linting and formatting the code. Remove redundant GitHub workflow in favour of pre-commit. \ No newline at end of file diff --git a/upcoming_changes/README.rst b/upcoming_changes/README.rst new file mode 100644 index 000000000..6de80b390 --- /dev/null +++ b/upcoming_changes/README.rst @@ -0,0 +1,36 @@ +This directory contains "news fragments" 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 hyperspy users +instead of describing internal changes which are only relevant to the developers. + +Each file should be named like ``..rst``, where +```` is an issue number, and ```` is one of: + +* ``new``: new user facing features, like new command-line options and new behavior. +* ``bugfix``: fixes a bug. +* ``doc``: documentation improvement, like rewording an entire session or adding missing docs. +* ``deprecation``: feature deprecation. +* ``enhancements``: improvement of existing functionality, usually without requiring user intervention. +* ``api``: a change which may break an existing script, such as feature removal or behavior change. +* ``maintenance``: a change related to the test suite, packaging, etc. + +So for example ``1412.new.rst`` or ``2773.bugfix.rst``. + +If your PR fixes an issue, use the number of the issue 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 ``new`` it is usually better to stick to a single paragraph to keep it concise. For ``new``, +it is recommended to add a hyperlink to the user guide. + +To make a draft of the changelog, run from the command line: + + .. code-block:: bash + + $ towncrier build --draft + +See https://github.com/twisted/towncrier for more details.