Sync with maint
[git.git] / Documentation / SubmittingPatches
blob98fc4cc1d002f3db2fc064bbc87d567503dc2624
1 Here are some guidelines for people who want to contribute their code
2 to this software.
4 (0) Decide what to base your work on.
6 In general, always base your work on the oldest branch that your
7 change is relevant to.
9  - A bugfix should be based on 'maint' in general. If the bug is not
10    present in 'maint', base it on 'master'. For a bug that's not yet
11    in 'master', find the topic that introduces the regression, and
12    base your work on the tip of the topic.
14  - A new feature should be based on 'master' in general. If the new
15    feature depends on a topic that is in 'pu', but not in 'master',
16    base your work on the tip of that topic.
18  - Corrections and enhancements to a topic not yet in 'master' should
19    be based on the tip of that topic. If the topic has not been merged
20    to 'next', it's alright to add a note to squash minor corrections
21    into the series.
23  - In the exceptional case that a new feature depends on several topics
24    not in 'master', start working on 'next' or 'pu' privately and send
25    out patches for discussion. Before the final merge, you may have to
26    wait until some of the dependent topics graduate to 'master', and
27    rebase your work.
29  - Some parts of the system have dedicated maintainers with their own
30    repositories (see the section "Subsystems" below).  Changes to
31    these parts should be based on their trees.
33 To find the tip of a topic branch, run "git log --first-parent
34 master..pu" and look for the merge commit. The second parent of this
35 commit is the tip of the topic branch.
37 (1) Make separate commits for logically separate changes.
39 Unless your patch is really trivial, you should not be sending
40 out a patch that was generated between your working tree and
41 your commit head.  Instead, always make a commit with complete
42 commit message and generate a series of patches from your
43 repository.  It is a good discipline.
45 Give an explanation for the change(s) that is detailed enough so
46 that people can judge if it is good thing to do, without reading
47 the actual patch text to determine how well the code does what
48 the explanation promises to do.
50 If your description starts to get too long, that's a sign that you
51 probably need to split up your commit to finer grained pieces.
52 That being said, patches which plainly describe the things that
53 help reviewers check the patch, and future maintainers understand
54 the code, are the most beautiful patches.  Descriptions that summarise
55 the point in the subject well, and describe the motivation for the
56 change, the approach taken by the change, and if relevant how this
57 differs substantially from the prior version, are all good things
58 to have.
60 Make sure that you have tests for the bug you are fixing.  See
61 t/README for guidance.
63 When adding a new feature, make sure that you have new tests to show
64 the feature triggers the new behaviour when it should, and to show the
65 feature does not trigger when it shouldn't.  Also make sure that the
66 test suite passes after your commit.  Do not forget to update the
67 documentation to describe the updated behaviour.
69 Speaking of the documentation, it is currently a liberal mixture of US
70 and UK English norms for spelling and grammar, which is somewhat
71 unfortunate.  A huge patch that touches the files all over the place
72 only to correct the inconsistency is not welcome, though.  Potential
73 clashes with other changes that can result from such a patch are not
74 worth it.  We prefer to gradually reconcile the inconsistencies in
75 favor of US English, with small and easily digestible patches, as a
76 side effect of doing some other real work in the vicinity (e.g.
77 rewriting a paragraph for clarity, while turning en_UK spelling to
78 en_US).  Obvious typographical fixes are much more welcomed ("teh ->
79 "the"), preferably submitted as independent patches separate from
80 other documentation changes.
82 Oh, another thing.  We are picky about whitespaces.  Make sure your
83 changes do not trigger errors with the sample pre-commit hook shipped
84 in templates/hooks--pre-commit.  To help ensure this does not happen,
85 run git diff --check on your changes before you commit.
88 (2) Describe your changes well.
90 The first line of the commit message should be a short description (50
91 characters is the soft limit, see DISCUSSION in git-commit(1)), and
92 should skip the full stop.  It is also conventional in most cases to
93 prefix the first line with "area: " where the area is a filename or
94 identifier for the general area of the code being modified, e.g.
96   . archive: ustar header checksum is computed unsigned
97   . git-cherry-pick.txt: clarify the use of revision range notation
99 If in doubt which identifier to use, run "git log --no-merges" on the
100 files you are modifying to see the current conventions.
102 The body should provide a meaningful commit message, which:
104   . explains the problem the change tries to solve, iow, what is wrong
105     with the current code without the change.
107   . justifies the way the change solves the problem, iow, why the
108     result with the change is better.
110   . alternate solutions considered but discarded, if any.
112 Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
113 instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
114 to do frotz", as if you are giving orders to the codebase to change
115 its behaviour.  Try to make sure your explanation can be understood
116 without external resources. Instead of giving a URL to a mailing list
117 archive, summarize the relevant points of the discussion.
120 (3) Generate your patch using Git tools out of your commits.
122 Git based diff tools generate unidiff which is the preferred format.
124 You do not have to be afraid to use -M option to "git diff" or
125 "git format-patch", if your patch involves file renames.  The
126 receiving end can handle them just fine.
128 Please make sure your patch does not add commented out debugging code,
129 or include any extra files which do not relate to what your patch
130 is trying to achieve. Make sure to review
131 your patch after generating it, to ensure accuracy.  Before
132 sending out, please make sure it cleanly applies to the "master"
133 branch head.  If you are preparing a work based on "next" branch,
134 that is fine, but please mark it as such.
137 (4) Sending your patches.
139 Learn to use format-patch and send-email if possible.  These commands
140 are optimized for the workflow of sending patches, avoiding many ways
141 your existing e-mail client that is optimized for "multipart/*" mime
142 type e-mails to corrupt and render your patches unusable.
144 People on the Git mailing list need to be able to read and
145 comment on the changes you are submitting.  It is important for
146 a developer to be able to "quote" your changes, using standard
147 e-mail tools, so that they may comment on specific portions of
148 your code.  For this reason, each patch should be submitted
149 "inline" in a separate message.
151 Multiple related patches should be grouped into their own e-mail
152 thread to help readers find all parts of the series.  To that end,
153 send them as replies to either an additional "cover letter" message
154 (see below), the first patch, or the respective preceding patch.
156 If your log message (including your name on the
157 Signed-off-by line) is not writable in ASCII, make sure that
158 you send off a message in the correct encoding.
160 WARNING: Be wary of your MUAs word-wrap
161 corrupting your patch.  Do not cut-n-paste your patch; you can
162 lose tabs that way if you are not careful.
164 It is a common convention to prefix your subject line with
165 [PATCH].  This lets people easily distinguish patches from other
166 e-mail discussions.  Use of additional markers after PATCH and
167 the closing bracket to mark the nature of the patch is also
168 encouraged.  E.g. [PATCH/RFC] is often used when the patch is
169 not ready to be applied but it is for discussion, [PATCH v2],
170 [PATCH v3] etc. are often seen when you are sending an update to
171 what you have previously sent.
173 "git format-patch" command follows the best current practice to
174 format the body of an e-mail message.  At the beginning of the
175 patch should come your commit message, ending with the
176 Signed-off-by: lines, and a line that consists of three dashes,
177 followed by the diffstat information and the patch itself.  If
178 you are forwarding a patch from somebody else, optionally, at
179 the beginning of the e-mail message just before the commit
180 message starts, you can put a "From: " line to name that person.
182 You often want to add additional explanation about the patch,
183 other than the commit message itself.  Place such "cover letter"
184 material between the three-dash line and the diffstat.  For
185 patches requiring multiple iterations of review and discussion,
186 an explanation of changes between each iteration can be kept in
187 Git-notes and inserted automatically following the three-dash
188 line via `git format-patch --notes`.
190 Do not attach the patch as a MIME attachment, compressed or not.
191 Do not let your e-mail client send quoted-printable.  Do not let
192 your e-mail client send format=flowed which would destroy
193 whitespaces in your patches. Many
194 popular e-mail applications will not always transmit a MIME
195 attachment as plain text, making it impossible to comment on
196 your code.  A MIME attachment also takes a bit more time to
197 process.  This does not decrease the likelihood of your
198 MIME-attached change being accepted, but it makes it more likely
199 that it will be postponed.
201 Exception:  If your mailer is mangling patches then someone may ask
202 you to re-send them using MIME, that is OK.
204 Do not PGP sign your patch, at least for now.  Most likely, your
205 maintainer or other people on the list would not have your PGP
206 key and would not bother obtaining it anyway.  Your patch is not
207 judged by who you are; a good patch from an unknown origin has a
208 far better chance of being accepted than a patch from a known,
209 respected origin that is done poorly or does incorrect things.
211 If you really really really really want to do a PGP signed
212 patch, format it as "multipart/signed", not a text/plain message
213 that starts with '-----BEGIN PGP SIGNED MESSAGE-----'.  That is
214 not a text/plain, it's something else.
216 Send your patch with "To:" set to the mailing list, with "cc:" listing
217 people who are involved in the area you are touching (the output from
218 "git blame $path" and "git shortlog --no-merges $path" would help to
219 identify them), to solicit comments and reviews.
221 After the list reached a consensus that it is a good idea to apply the
222 patch, re-send it with "To:" set to the maintainer [*1*] and "cc:" the
223 list [*2*] for inclusion.
225 Do not forget to add trailers such as "Acked-by:", "Reviewed-by:" and
226 "Tested-by:" lines as necessary to credit people who helped your
227 patch.
229     [Addresses]
230      *1* The current maintainer: gitster@pobox.com
231      *2* The mailing list: git@vger.kernel.org
234 (5) Sign your work
236 To improve tracking of who did what, we've borrowed the
237 "sign-off" procedure from the Linux kernel project on patches
238 that are being emailed around.  Although core Git is a lot
239 smaller project it is a good discipline to follow it.
241 The sign-off is a simple line at the end of the explanation for
242 the patch, which certifies that you wrote it or otherwise have
243 the right to pass it on as a open-source patch.  The rules are
244 pretty simple: if you can certify the below:
246         Developer's Certificate of Origin 1.1
248         By making a contribution to this project, I certify that:
250         (a) The contribution was created in whole or in part by me and I
251             have the right to submit it under the open source license
252             indicated in the file; or
254         (b) The contribution is based upon previous work that, to the best
255             of my knowledge, is covered under an appropriate open source
256             license and I have the right under that license to submit that
257             work with modifications, whether created in whole or in part
258             by me, under the same open source license (unless I am
259             permitted to submit under a different license), as indicated
260             in the file; or
262         (c) The contribution was provided directly to me by some other
263             person who certified (a), (b) or (c) and I have not modified
264             it.
266         (d) I understand and agree that this project and the contribution
267             are public and that a record of the contribution (including all
268             personal information I submit with it, including my sign-off) is
269             maintained indefinitely and may be redistributed consistent with
270             this project or the open source license(s) involved.
272 then you just add a line saying
274         Signed-off-by: Random J Developer <random@developer.example.org>
276 This line can be automatically added by Git if you run the git-commit
277 command with the -s option.
279 Notice that you can place your own Signed-off-by: line when
280 forwarding somebody else's patch with the above rules for
281 D-C-O.  Indeed you are encouraged to do so.  Do not forget to
282 place an in-body "From: " line at the beginning to properly attribute
283 the change to its true author (see (2) above).
285 Also notice that a real name is used in the Signed-off-by: line. Please
286 don't hide your real name.
288 If you like, you can put extra tags at the end:
290 1. "Reported-by:" is used to credit someone who found the bug that
291    the patch attempts to fix.
292 2. "Acked-by:" says that the person who is more familiar with the area
293    the patch attempts to modify liked the patch.
294 3. "Reviewed-by:", unlike the other tags, can only be offered by the
295    reviewer and means that she is completely satisfied that the patch
296    is ready for application.  It is usually offered only after a
297    detailed review.
298 4. "Tested-by:" is used to indicate that the person applied the patch
299    and found it to have the desired effect.
301 You can also create your own tag or use one that's in common usage
302 such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
304 ------------------------------------------------
305 Subsystems with dedicated maintainers
307 Some parts of the system have dedicated maintainers with their own
308 repositories.
310  - git-gui/ comes from git-gui project, maintained by Pat Thoyts:
312         git://repo.or.cz/git-gui.git
314  - gitk-git/ comes from Paul Mackerras's gitk project:
316         git://ozlabs.org/~paulus/gitk
318  - po/ comes from the localization coordinator, Jiang Xin:
320         https://github.com/git-l10n/git-po/
322 Patches to these parts should be based on their trees.
324 ------------------------------------------------
325 An ideal patch flow
327 Here is an ideal patch flow for this project the current maintainer
328 suggests to the contributors:
330  (0) You come up with an itch.  You code it up.
332  (1) Send it to the list and cc people who may need to know about
333      the change.
335      The people who may need to know are the ones whose code you
336      are butchering.  These people happen to be the ones who are
337      most likely to be knowledgeable enough to help you, but
338      they have no obligation to help you (i.e. you ask for help,
339      don't demand).  "git log -p -- $area_you_are_modifying" would
340      help you find out who they are.
342  (2) You get comments and suggestions for improvements.  You may
343      even get them in a "on top of your change" patch form.
345  (3) Polish, refine, and re-send to the list and the people who
346      spend their time to improve your patch.  Go back to step (2).
348  (4) The list forms consensus that the last round of your patch is
349      good.  Send it to the maintainer and cc the list.
351  (5) A topic branch is created with the patch and is merged to 'next',
352      and cooked further and eventually graduates to 'master'.
354 In any time between the (2)-(3) cycle, the maintainer may pick it up
355 from the list and queue it to 'pu', in order to make it easier for
356 people play with it without having to pick up and apply the patch to
357 their trees themselves.
359 ------------------------------------------------
360 Know the status of your patch after submission
362 * You can use Git itself to find out when your patch is merged in
363   master. 'git pull --rebase' will automatically skip already-applied
364   patches, and will let you know. This works only if you rebase on top
365   of the branch in which your patch has been merged (i.e. it will not
366   tell you if your patch is merged in pu if you rebase on top of
367   master).
369 * Read the Git mailing list, the maintainer regularly posts messages
370   entitled "What's cooking in git.git" and "What's in git.git" giving
371   the status of various proposed changes.
373 ------------------------------------------------
374 MUA specific hints
376 Some of patches I receive or pick up from the list share common
377 patterns of breakage.  Please make sure your MUA is set up
378 properly not to corrupt whitespaces.
380 See the DISCUSSION section of git-format-patch(1) for hints on
381 checking your patch by mailing it to yourself and applying with
382 git-am(1).
384 While you are at it, check the resulting commit log message from
385 a trial run of applying the patch.  If what is in the resulting
386 commit is not exactly what you would want to see, it is very
387 likely that your maintainer would end up hand editing the log
388 message when he applies your patch.  Things like "Hi, this is my
389 first patch.\n", if you really want to put in the patch e-mail,
390 should come after the three-dash line that signals the end of the
391 commit message.
394 Pine
395 ----
397 (Johannes Schindelin)
399 I don't know how many people still use pine, but for those poor
400 souls it may be good to mention that the quell-flowed-text is
401 needed for recent versions.
403 ... the "no-strip-whitespace-before-send" option, too. AFAIK it
404 was introduced in 4.60.
406 (Linus Torvalds)
408 And 4.58 needs at least this.
410 ---
411 diff-tree 8326dd8350be64ac7fc805f6563a1d61ad10d32c (from e886a61f76edf5410573e92e38ce22974f9c40f1)
412 Author: Linus Torvalds <torvalds@g5.osdl.org>
413 Date:   Mon Aug 15 17:23:51 2005 -0700
415     Fix pine whitespace-corruption bug
417     There's no excuse for unconditionally removing whitespace from
418     the pico buffers on close.
420 diff --git a/pico/pico.c b/pico/pico.c
421 --- a/pico/pico.c
422 +++ b/pico/pico.c
423 @@ -219,7 +219,9 @@ PICO *pm;
424             switch(pico_all_done){      /* prepare for/handle final events */
425               case COMP_EXIT :          /* already confirmed */
426                 packheader();
427 +#if 0
428                 stripwhitespace();
429 +#endif
430                 c |= COMP_EXIT;
431                 break;
434 (Daniel Barkalow)
436 > A patch to SubmittingPatches, MUA specific help section for
437 > users of Pine 4.63 would be very much appreciated.
439 Ah, it looks like a recent version changed the default behavior to do the
440 right thing, and inverted the sense of the configuration option. (Either
441 that or Gentoo did it.) So you need to set the
442 "no-strip-whitespace-before-send" option, unless the option you have is
443 "strip-whitespace-before-send", in which case you should avoid checking
444 it.
447 Thunderbird, KMail, GMail
448 -------------------------
450 See the MUA-SPECIFIC HINTS section of git-format-patch(1).
452 Gnus
453 ----
455 '|' in the *Summary* buffer can be used to pipe the current
456 message to an external program, and this is a handy way to drive
457 "git am".  However, if the message is MIME encoded, what is
458 piped into the program is the representation you see in your
459 *Article* buffer after unwrapping MIME.  This is often not what
460 you would want for two reasons.  It tends to screw up non ASCII
461 characters (most notably in people's names), and also
462 whitespaces (fatal in patches).  Running 'C-u g' to display the
463 message in raw form before using '|' to run the pipe can work
464 this problem around.