CONTRIBUTING: Extend patch, committer and maintainer guidelines.

Signed-off-by: Mark Wielaard <mjw@redhat.com>

diff --git a/CONTRIBUTING b/CONTRIBUTING
index 3f5e5aa698faea536050d9814d94d3d98f69c429..f267a544d208e15adfde267180251d56152ccff5 100644 (file)
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -46,3 +46,56 @@ 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 expected to have zero failing tests.
+Do not knowingly add tests that FAIL. If there are architectures or
+configurations where a tests is not supported make sure they are
+skipped instead of failing. Adding "exit 77" in the test shell wrapper
+indicates that a test was SKIPPED.
+
+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:
+https://admin.fedoraproject.org/accounts/group/members/gitelfutils/*
+
+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:
+https://admin.fedoraproject.org/accounts/
+Upload a SSH public key and have an existing maintainer sponsor you
+for the Elf Utils Group (gitelfutils).
+
+committers can push patches through:
+ssh://<fasname>@git.fedorahosted.org/git/elfutils.git
+
+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 1ec202ac9ae424a8f54e1aa4c23f4cf23db303a1..1a7d9ccf10c36c646c60dc75a51eb0727e3c08b9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2016-06-10  Mark Wielaard  <mjw@redhat.com>
+
+       * CONTRIBUTING: Extend patch, committer and maintainer guidelines.
+
 2016-05-02  Filipe Brandenburger  <filbranden@google.com>
 
        * configure.ac (argp check): Pass pass &argv.