pacman/submitting-patches

Pacman - Submitting Patches
===========================

This document is here mainly to make my job easier, and is more of a guideline,
and not a strict set of rules.  Please try to follow as much as you can.

NOTE: Some of this is paraphrased from the kernel documentation's
"SubmittingPatches" file.

Creating your patch
-------------------

Patches need to be submitted in GIT format. So for getting started, you will
have to read some git guides first, to learn how to fetch pacman git repo, how
to configure your name and email adress, how to create a branch, a commit, and
finally your patch.

--
* use git commit -s for creating a commit of your changes.

The -s allows you to credit yourself by adding a "Signed Off By" line to
indicate who has "signed" the patch - who has approved it.

    Signed-off-by: Aaron Griffin <aaron@archlinux.org>

Please use your real name and email address. Feel free to "scramble" the
address if you're afraid of spam.

* Describe your patch.

It helps if you describe the changes of the patch in the git commit log.
This allows others to see what you intended so as to compare it to
what was actually done, and allows better feedback.

* Use git format-patch to create patches.

Your commit message will be shown above the patch by default when you will use
`git-format-patch`, including the signoff line.
--

Submitting your patch
---------------------

--
* Send the patch to the pacman-dev mailing list

The mailing list is the primary queue for review and acceptance.  Here you
will get feedback, and let me know the details of your patch.

* No MIME, no links, no compression, no attachments.  Just plain text.

Patches should be contained in the actual body of the email.  There are many
reasons for this.  Firstly, it makes them easier to read with any mail reader,
it allows easier review "at a glance", and most importantly, it allows people
to comment on exact lines of the patch in reply emails.

git send-email allows you to send git formatted patches in plain text easily.

--

After you submit
----------------

--
* Don't get discouraged

Any feedback you get, positive or negative, has nothing to do with you.  If a
patch is rejected, try taking the suggestions into account and re-submitting.
We welcome most submissions here, and some may take a bit longer to get
looked over than others. If you think your patch got lost in the shuffle,
send another email to the list in reply to the original asking if anyone has
looked at it yet.
--

/////
vim: set ts=2 sw=2 syntax=asciidoc et:
/////