gnunet-handbook

commit 9c5b9d9040d21542eff792e26624cf9669b127aa
parent 378f616d277a6064653175c11dc318263069fb80
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date:   Wed, 18 Jan 2023 19:46:52 +0900

Update changelog / NEWS style guideline

Diffstat:
M
developers/style.rst
 | 
21
+++++++++++++++------

1 file changed, 15 insertions(+), 6 deletions(-)
diff --git a/developers/style.rst b/developers/style.rst
@@ -391,8 +391,9 @@ Commit messages and developer branches
 ======================================
 
 You can find the GNUnet project repositories at https://git.gnunet.org.
-For each release, the ChangeLog file is generated from the commit
-history. Hence, commit messages are required to convey what changes were
+We do not maintain a separate ChangeLog file anymore as the changes are
+documented in the git repositories.
+Commit messages are required to convey what changes were
 made in a self-contained fashion. Commit messages such as \"fix\" or
 \"cleanup\" are not acceptable. You commit message should ideally start
 with the subsystem name and be followed by a succinct description of the
@@ -404,14 +405,22 @@ may also be included. Example:
    # <subsystem>: <description>. (#XXXX)
    IDENTITY: Fix wrong key construction for anonymous ECDSA identity. (Fixes #12344)
 
-If you need to commit a minor fix you may prefix the commit message with
-a dash. It will then be ignored when generating the ChangeLog entries:
+If you edit files that change user-facing behaviour (e.g. header files in src/include)
+you will have to add at least one line in the commit message starting with \"NEWS:\".
+If there is a special reason why you deem this unnecessary, you can add the line
+\"NEWS: -\".
+Any \"NEWS\" lines from commit messages will on release be put into the "NEWS" file in the tarball
+to inform users and packages of noteworthy changes.
 
 .. code-block:: text
 
-   # -<text>
-   -fix
+   # NEWS
+   NEWS: The API for foo has changed: lorem ipsum.
 
+Note that if you run \"./bootstrap\" hooks will be installed that add message hints
+to your commit message template when you run \"git commit\" and if you fail
+to provide a "NEWS:" line when required the commit will fail.
+   
 If you need to modify a commit you can do so using:
 
 .. code-block:: console