diff options
author | Mark Wielaard <mjw@redhat.com> | 2016-06-10 14:03:15 +0200 |
---|---|---|
committer | Mark Wielaard <mjw@redhat.com> | 2016-06-21 21:43:02 +0200 |
commit | c954bc4e35bef39ac0f1a1151793a8d88d4e3c29 (patch) | |
tree | 932346a80ad75014a8ef2fcc7f7d98c9be7f671e | |
parent | 37bb3fcd9010f6fead99568613b2aa8a7fcdc703 (diff) | |
download | elfutils-c954bc4e35bef39ac0f1a1151793a8d88d4e3c29.tar.gz |
CONTRIBUTING: Extend patch, committer and maintainer guidelines.
Signed-off-by: Mark Wielaard <mjw@redhat.com>
-rw-r--r-- | CONTRIBUTING | 53 | ||||
-rw-r--r-- | ChangeLog | 4 |
2 files changed, 57 insertions, 0 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING index 3f5e5aa6..f267a544 100644 --- 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. @@ -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. |