diff --git a/doc/contributors_guide.rst b/doc/contributors_guide.rst index 14e8296327360ee25a6ea00c3b3f5f9d52e5a61a..7453caefa94c5925f967920b7f098fcb0443aac3 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