@matheusbsbs / matheus-bagliano / commits / 56333bac66
Fork 0

Begin SubmittingPatches with a check list

It seems that some people prefer a short list to a long text. But even for the latter group, a quick reminder list is useful. So, add a check list to Documentation/SubmittingPatches of what to do to get your patch accepted. Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>

Johannes Schindelin committed Mar 5, 2007 at 16:37 UTC 56333bac66ccdefa3f6d67f78da9f5267119c4a6
1 file changed +27
Documentation/SubmittingPatches
+27
@@ -1,3 +1,30 @@
1 +Checklist (and a short version for the impatient):
2 +
3 + - make commits of logical units
4 + - check for unnecessary whitespace with "git diff --check"
5 + before committing
6 + - do not check in commented out code or unneeded files
7 + - provide a meaningful commit message
8 + - the first line of the commit message should be a short
9 + description and should skip the full stop
10 + - if you want your work included in git.git, add a
11 + "Signed-off-by: Your Name <your@email.com>" line to the
12 + commit message (or just use the option "-s" when
13 + committing) to confirm that you agree to the Developer's
14 + Certificate of Origin
15 + - do not PGP sign your patch
16 + - use "git format-patch -M" to create the patch
17 + - do not attach your patch, but read in the mail
18 + body, unless you cannot teach your mailer to
19 + leave the formatting of the patch alone.
20 + - be careful doing cut & paste into your mailer, not to
21 + corrupt whitespaces.
22 + - provide additional information (which is unsuitable for
23 + the commit message) between the "---" and the diffstat
24 + - send the patch to the list _and_ the maintainer
25 +
26 +Long version:
27 +
28 I started reading over the SubmittingPatches document for Linux
29 kernel, primarily because I wanted to have a document similar to
30 it for the core GIT to make sure people understand what they are