From 6e8609208232c7bf4e4650250e6e8a55ff83f1f0 Mon Sep 17 00:00:00 2001 From: Wei Lee Date: Tue, 26 Nov 2024 18:51:07 +0800 Subject: [PATCH] docs(contributing-docs): add sigificant file template description --- contributing-docs/16_contribution_workflow.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/contributing-docs/16_contribution_workflow.rst b/contributing-docs/16_contribution_workflow.rst index 8c941f8afc7a4..1c933ebe9e780 100644 --- a/contributing-docs/16_contribution_workflow.rst +++ b/contributing-docs/16_contribution_workflow.rst @@ -196,7 +196,12 @@ Step 4: Prepare PR and place in either `newsfragments `__ for core newsfragments, or `chart/newsfragments `__ for helm chart newsfragments. - In general newsfragments must be one line. For newsfragment type ``significant``, you may include summary and body separated by a blank line, similar to ``git`` commit messages. + 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. + This can also be done by the following command. + +.. code-block:: bash + uv tool run towncrier create --dir . --config newsfragments/config.toml --content "`cat newsfragments/template.significant.rst`" 2. Rebase your fork, squash commits, and resolve all conflicts. See `How to rebase PR <#how-to-rebase-pr>`_ if you need help with rebasing your change. Remember to rebase often if your PR takes a lot of time to