From 446f14db53776ffc1a4533f85e76d515e7b38102 Mon Sep 17 00:00:00 2001 From: Douglas Raillard Date: Mon, 13 Feb 2023 11:03:15 +0000 Subject: [PATCH] doc/contributors_guide.rst: Update contributors_guide.rst for changelog Add a changelog markers example in the contributor's guide. --- doc/contributors_guide.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/contributors_guide.rst b/doc/contributors_guide.rst index 14e829632..7453caefa 100644 --- a/doc/contributors_guide.rst +++ b/doc/contributors_guide.rst @@ -61,6 +61,18 @@ prefix can be omitted - for instance, if you’re modifying the ``lisa/wlgen/rta.py`` file, we’d expect a header of the shape ``lisa.wlgen.rta: ...``. +It should also contain a ``FIX``, ``FEATURE`` or ``BREAKING CHANGE`` tag that +will be used to generate the changelog, such as: + +.. code-block:: text + + lisa.foo.bar: Fix some foobar + + FIX + + This fix fixes fixable fixtures by affixing an postfix operator. + + When in doubt, have a look at the git log. Subtrees -- GitLab