From: Mark Wielaard <mark@klomp.org>
Date: Thu, 19 Oct 2023 15:43:01 +0000 (+0200)
Subject: CONTRIBUTING: Update ChangeLog policy, mention patchwork and try bots
X-Git-Tag: elfutils-0.190~11
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=f23a30d52119c3a94b6e83a45420d4d973d417e0;p=thirdparty%2Felfutils.git

CONTRIBUTING: Update ChangeLog policy, mention patchwork and try bots

Signed-off-by: Mark Wielaard <mark@klomp.org>
---

diff --git a/CONTRIBUTING b/CONTRIBUTING
index 1a1c443f0..4b6fac209 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -52,8 +52,21 @@ or false name that misrepresents who you are.
 git commit --signoff will add such a Signed-off-by line at the end of
 the commit log message for you.
 
-The ideal patch contains a ChangeLog entry and a test case for the
-bug fixed or feature added.
+The ideal patch contains a ChangeLog entry for the commit message and
+a test case for the bug fixed or feature added.
+
+The commit message is expected to start with a one line summary of
+what the patch does, prefixed with the main subdir the patch applies
+to. e.g libelf: Rewind the elf_frob function bar definitions.
+
+Finally please include an ChangeLog entry explicitly listing the files
+and what changed in each of them in the commit message. This will help
+a reviewer understand which changes are expected (and which might be
+accidential). Try to follow the GNU Change Log style:
+https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html
+Note that elfutils previously maintained separate ChangeLog
+files. These are no longer used. All changes should be documented in
+the git commit message.
 
 The testsuite (make check) is expected to have zero failing tests.
 Do not knowingly add tests that FAIL. If there are architectures or
@@ -71,6 +84,22 @@ After sending your patch to the mailinglist one of the committers
 to the project will review it, give feedback, and if perfect they
 will commit it for you.
 
+All patches sent to the mailing list are tracked at
+https://patchwork.sourceware.org/project/elfutils/list/
+
+To use this from the command line you can use git-pw
+https://patchwork.readthedocs.io/projects/git-pw/en/latest/
+
+For using it with git-pw use these .git/config settings:
+  [pw]
+    server = https://patchwork.sourceware.org/api/1.2/
+    project = elfutils
+    token = <hex-token>
+    states = committed,accepted,superseded,deferred,rejected,under-review
+
+If you would like to help maintain the pending patch list your
+patchwork account can be added as maintainer for the elfutils project.
+
 You can become a maintainer/committer yourself after you have provided
 at least a handful of accepted patches and agree to the guidelines in
 this document for creating, reviewing, accepting and committing patches.
@@ -102,6 +131,11 @@ be aimed at integration into master. For merging a branch into master
 the same process as above should be followed by posting the patches
 to the list first.
 
+Note that a branch starting with <nickname>/try... will be picked up
+by the Sourceware buildbot and can be used to test your patches before
+merging into the main branch:
+https://builder.sourceware.org/buildbot/#/builders?tags=elfutils-try
+
 committers/maintainers who repeatedly ignore the above guidelines,
 are hostile or offensive towards other committers or contributors,
 and don't correct their behavior after being asked by other committers