From 55161fe515ae0988a42cfb3c4f9eca55cf34a137 Mon Sep 17 00:00:00 2001 From: Amogh Desai Date: Fri, 14 Feb 2025 12:05:20 +0530 Subject: [PATCH] Clarify what a significant newsfrag means --- contributing-docs/16_contribution_workflow.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/contributing-docs/16_contribution_workflow.rst b/contributing-docs/16_contribution_workflow.rst index 4b3e77a706dc1..aaea43606bb51 100644 --- a/contributing-docs/16_contribution_workflow.rst +++ b/contributing-docs/16_contribution_workflow.rst @@ -198,6 +198,7 @@ Step 4: Prepare PR In general newsfragments must be one line. For newsfragment type ``significant``, you should follow the template in ``newsfragments/template.significant.rst`` to include summary, body, change type and migrations rules needed. + One thing to note here is that a ``significant`` newsfragment always doesn't have to be a breaking change, i.e. it can not have a change type and migration rules. This can also be done by the following command. .. code-block:: bash