Blame CONTRIBUTING

Packit 032894
The project home is http://elfutils.org/
Packit 032894
Packit 032894
The current elfutils source code can be checked out with
Packit 032894
git clone git://sourceware.org/git/elfutils.git
Packit 032894
Packit 032894
The developer mailinglist to send patches to is
Packit 032894
elfutils-devel@sourceware.org.
Packit 032894
https://sourceware.org/ml/elfutils-devel/
Packit 032894
Packit 032894
To subscribe send an email to elfutils-devel-subscribe@sourceware.org
Packit Service 35cfd5
Or use the form at https://sourceware.org/mailman/listinfo/elfutils-devel
Packit 032894
Packit 032894
Please supply patches using git format-patch or using git send-email.
Packit 032894
Packit 032894
Sign your work
Packit 032894
Packit 032894
To facilitate tracking of who did what, we've adopted a "sign-off"
Packit 032894
procedure for patches based on the procedure used by the Linux kernel
Packit 032894
project.
Packit 032894
Packit 032894
The sign-off is a simple line at the end of the explanation for the
Packit 032894
patch, which certifies that you wrote it or otherwise have the right
Packit 032894
to pass it on as a patch under an appropriate license. The rules are
Packit 032894
pretty simple: if you can certify the below:
Packit 032894
Packit 032894
        Developer's Certificate of Origin
Packit 032894
Packit 032894
        By making a contribution to this project, I certify that:
Packit 032894
Packit 032894
	(a) The contribution was created in whole or in part by me,
Packit 032894
	    and I have the right to submit the contribution under each
Packit 032894
	    license indicated in, or otherwise designated as being
Packit 032894
	    applicable to, the file.
Packit 032894
Packit 032894
        (b) The contribution was provided directly to me by some other
Packit 032894
            person who certified (a), and I have not modified it.
Packit 032894
Packit 032894
        (c) I understand and agree that the project and the
Packit 032894
            contribution are public and that a record of the
Packit 032894
            contribution (including all personal information I submit
Packit 032894
            with it, including my sign-off) is maintained indefinitely
Packit 032894
            and may be redistributed.
Packit 032894
Packit 032894
then you just add a line saying
Packit 032894
Packit 032894
Signed-off-by: Random J Developer <random@developer.example.org>
Packit 032894
Packit 032894
using your real name (sorry, no pseudonyms or anonymous contributions.)
Packit 032894
Packit 032894
git commit --signoff will add such a Signed-off-by line at the end of
Packit 032894
the commit log message for you.
Packit 032894
Packit 032894
The ideal patch contains a ChangeLog entry and a test case for the
Packit 032894
bug fixed or feature added.
Packit 032894
Packit 032894
The testsuite (make check) is expected to have zero failing tests.
Packit 032894
Do not knowingly add tests that FAIL. If there are architectures or
Packit 032894
configurations where a tests is not supported make sure they are
Packit 032894
skipped instead of failing. Adding "exit 77" in the test shell wrapper
Packit 032894
indicates that a test was SKIPPED.
Packit 032894
Packit 032894
We do allow binaries in the testsuite for tests that only need to
Packit 032894
read ELF or DWARF data and if generating the data in the testcase
Packit 032894
itself is difficult or would be architecture specific.
Packit 032894
The binaries should be bzip2 compressed. Add a note in the test
Packit 032894
wrapper run-<testcase>.sh script how to regenerate the binary.
Packit 032894
Packit 032894
After sending your patch to the mailinglist one of the committers
Packit 032894
to the project will review it, give feedback, and if perfect they
Packit 032894
will commit it for you.
Packit 032894
Packit 032894
You can become a maintainer/committer yourself after you have provided
Packit 032894
at least a handful of accepted patches and agree to the guidelines in
Packit 032894
this document for creating, reviewing, accepting and committing patches.
Packit 032894
Packit 032894
To become a committer you need a sourceware account:
Packit 032894
https://sourceware.org/cgi-bin/pdw/ps_form.cgi
Packit 032894
Upload a SSH public key and have an existing maintainer sponsor you
Packit 032894
for the elfutils group.
Packit 032894
Packit 032894
committers can push patches through:
Packit 032894
ssh://<user>@sourceware.org/git/elfutils.git
Packit 032894
Packit 032894
The current webpages published at https://sourceware.org/elfutils/
Packit 032894
can be checked out with:
Packit 032894
git clone ssh://<user>@sourceware.org/git/elfutils-htdocs.git
Packit 032894
Patches should also be posted to the mailinglist.
Packit 032894
Packit 032894
As a maintainer/committer you should still post patches as described
Packit 032894
above. And ideally they are reviewed and approved as above. If no
Packit 032894
other committer has reviewed or objected to your patch for a week
Packit 032894
you may use your own judgement whether you ping your patch or push
Packit 032894
it after "self-review". If you do, you should post a message to the
Packit 032894
mailinglist that the patch has been pushed.
Packit 032894
Packit 032894
committers may also create git branches starting with <nickname>/...
Packit 032894
patches on these branches are works in progress, so might not be perfect
Packit 032894
yet, but should follow the above guidelines as much as possible and should
Packit 032894
be aimed at integration into master. For merging a branch into master
Packit 032894
the same process as above should be followed by posting the patches
Packit 032894
to the list first.
Packit 032894
Packit 032894
committers/maintainers who repeatedly ignore the above guidelines,
Packit 032894
are hostile or offensive towards other committers or contributors,
Packit 032894
and don't correct their behavior after being asked by other committers
Packit 032894
will be removed as maintainer/committer.