| blob | 715f84d80faf56a97eed34e4eb859f94fcfb9e1e |
1 Checklist for Patches:
2 //////////////////////
4 Submitting patches should follow this guideline (derived from the Git project):
6 * Commits:
8 - make sure to comply with the coding guidelines (see CodingStyle)
9 - make commits of logical units
10 - check for unnecessary whitespace with "git diff --check" before committing
11 - do not check in commented out code or unneeded files
12 - the first line of the commit message should be a short description (50
13 characters is the soft limit, see DISCUSSION in git-commit(1)), and should
14 skip the full stop
15 - the body should provide a meaningful commit message, which:
16 . explains the problem the change tries to solve, iow, what is wrong with
17 the current code without the change.
18 . justifies the way the change solves the problem, iow, why the result with
19 the change is better.
20 . alternate solutions considered but discarded, if any.
21 - describe changes in imperative mood, e.g. "make xyzzy do frotz" instead of
22 "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy to do frotz", as
23 if you are giving orders to the codebase to change its behaviour.
24 - try to make sure your explanation can be understood without external
25 resources. Instead of giving a URL to a mailing list archive, summarize the
26 relevant points of the discussion.
27 - add a "Signed-off-by: Your Name <you@example.com>" line to the commit message
28 (or just use the option "-s" when committing) to confirm that you agree to
29 the Developer's Certificate of Origin (see also
30 http://linux.yyz.us/patch-format.html or below); this is mandatory
31 - make sure syntax of man-pages is free of errors: podchecker <tool>.c
33 * For Patches via GitHub:
35 - fork the netsniff-ng project on GitHub to your local GitHub account
36 (https://github.com/gnumaniacs/netsniff-ng)
37 - make your changes to the latest master branch with respect to the commit
38 section above
39 - if you change, add, or remove a command line option or make some other user
40 interface change, the associated documentation should be updated as well.
41 - open a pull request on (https://github.com/gnumaniacs/netsniff-ng) and send
42 a notification to the list (netsniff-ng@googlegroups.com) and the maintainer
43 (bugs@netsniff-ng.org) if (and only if) the patch is ready for inclusion.
44 - if your name is not writable in ASCII, make sure that you send off a message
45 in the correct encoding.
46 - add a short description what the patch or patchset is about
48 * For Patches via Mail:
50 - use "git format-patch -M" to create the patch
51 - do not PGP sign your patch
52 - do not attach your patch, but read in the mail body, unless you cannot teach
53 your mailer to leave the formatting of the patch alone.
54 - be careful doing cut & paste into your mailer, not to corrupt whitespaces.
55 - provide additional information (which is unsuitable for the commit message)
56 between the "---" and the diffstat
57 - if you change, add, or remove a command line option or make some other user
58 interface change, the associated documentation should be updated as well.
59 - if your name is not writable in ASCII, make sure that you send off a message
60 in the correct encoding.
61 - send the patch to the list (netsniff-ng@googlegroups.com) and the maintainer
62 (bugs@netsniff-ng.org) if (and only if) the patch is ready for inclusion.
63 If you use git-send-email(1), please test it first by sending email to
64 yourself.
66 * What does the 'Signed-off-by' mean?
68 It certifies the following (extract from the Linux kernel documentation):
70 Developer's Certificate of Origin 1.1
72 By making a contribution to this project, I certify that:
73 (a) The contribution was created in whole or in part by me and I
74 have the right to submit it under the open source license
75 indicated in the file; or
76 (b) The contribution is based upon previous work that, to the best
77 of my knowledge, is covered under an appropriate open source
78 license and I have the right under that license to submit that
79 work with modifications, whether created in whole or in part
80 by me, under the same open source license (unless I am
81 permitted to submit under a different license), as indicated
82 in the file; or
83 (c) The contribution was provided directly to me by some other
84 person who certified (a), (b) or (c) and I have not modified it.
85 (d) I understand and agree that this project and the contribution
86 are public and that a record of the contribution (including all
87 personal information I submit with it, including my sign-off) is
88 maintained indefinitely and may be redistributed consistent with
89 this project or the open source license(s) involved.
91 then you just add a line saying
92 Signed-off-by: Random J Developer <random@developer.example.org>
93 using your real name (sorry, no pseudonyms or anonymous contributions).
95 * Example commit:
97 Please write good git commit messages. A good commit message looks like this:
99 Header line: explaining the commit in one line
101 Body of commit message is a few lines of text, explaining things
102 in more detail, possibly giving some background about the issue
103 being fixed, etc etc.
105 The body of the commit message can be several paragraphs, and
106 please do proper word-wrap and keep columns shorter than about
107 74 characters or so. That way "git log" will show things
108 nicely even when it's indented.
110 Reported-by: whoever-reported-it
111 Signed-off-by: Your Name <youremail@yourhost.com>
113 where that header line really should be meaningful, and really should be
114 just one line. That header line is what is shown by tools like gitk and
115 shortlog, and should summarize the change in one readable line of text,
116 independently of the longer explanation.
118 Note that future (0.5.7 onwards) changelogs will include a summary that is
119 generated by 'git shortlog -n'. Hence, that's why we need you to stick to
120 the convention.