This is the mail archive of the mailing list for the elfutils project.

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[PATCH] CONTRIBUTING: Extend patch, committer and maintainer guidelines.

Signed-off-by: Mark Wielaard <>
 CONTRIBUTING | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 ChangeLog    |  4 ++++
 2 files changed, 52 insertions(+)

index 3f5e5aa..418b9c7 100644
@@ -46,3 +46,51 @@ using your real name (sorry, no pseudonyms or anonymous contributions.)
 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 testsuite (make check) is zero FAIL.
+Do not commit patches if you know they might break a testcase.
+We do allow binaries in the testsuite for tests that only need to
+read ELF or DWARF data and if generating the data in the testcase
+itself is difficult or would be architecture specific.
+The binaries should be bzip2 compressed. Add a note in the test
+wrapper run-<testcase>.sh script how to regenerate the binary.
+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.
+The current maintainers/committers can be found at:
+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.
+To become a committer you need an FAS account at:
+Upload a SSH public key and have an existing maintainer sponsor you
+for the Elf Utils Group (gitelfutils).
+committers can push patches through:
+As a maintainer/committer you should still post patches as described
+above. And ideally they are reviewed and approved as above. If no
+other committer has reviewed or objected to your patch for a week
+you may use your own judgement whether you ping your patch or push
+it after "self-review". If you do, you should post a message to the
+mailinglist that the patch has been pushed.
+committers may also create git branches starting with <fasname>/...
+patches on these branches are works in progress, so might not be perfect
+yet, but should follow the above guidelines as much as possible and should
+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.
+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
+will be removed as maintainer/committer.
diff --git a/ChangeLog b/ChangeLog
index 1ec202a..1a7d9cc 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2016-06-10  Mark Wielaard  <>
+	* CONTRIBUTING: Extend patch, committer and maintainer guidelines.
 2016-05-02  Filipe Brandenburger  <>
 	* (argp check): Pass pass &argv.

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]