Merge branch 'jb/multi-pack-index-docfix'
[git] / Documentation / SubmittingPatches
1 Submitting Patches
2 ==================
3
4 == Guidelines
5
6 Here are some guidelines for people who want to contribute their code
7 to this software.
8
9 [[base-branch]]
10 === Decide what to base your work on.
11
12 In general, always base your work on the oldest branch that your
13 change is relevant to.
14
15 * A bugfix should be based on `maint` in general. If the bug is not
16   present in `maint`, base it on `master`. For a bug that's not yet
17   in `master`, find the topic that introduces the regression, and
18   base your work on the tip of the topic.
19
20 * A new feature should be based on `master` in general. If the new
21   feature depends on a topic that is in `pu`, but not in `master`,
22   base your work on the tip of that topic.
23
24 * Corrections and enhancements to a topic not yet in `master` should
25   be based on the tip of that topic. If the topic has not been merged
26   to `next`, it's alright to add a note to squash minor corrections
27   into the series.
28
29 * In the exceptional case that a new feature depends on several topics
30   not in `master`, start working on `next` or `pu` privately and send
31   out patches for discussion. Before the final merge, you may have to
32   wait until some of the dependent topics graduate to `master`, and
33   rebase your work.
34
35 * Some parts of the system have dedicated maintainers with their own
36   repositories (see the section "Subsystems" below).  Changes to
37   these parts should be based on their trees.
38
39 To find the tip of a topic branch, run `git log --first-parent
40 master..pu` and look for the merge commit. The second parent of this
41 commit is the tip of the topic branch.
42
43 [[separate-commits]]
44 === Make separate commits for logically separate changes.
45
46 Unless your patch is really trivial, you should not be sending
47 out a patch that was generated between your working tree and
48 your commit head.  Instead, always make a commit with complete
49 commit message and generate a series of patches from your
50 repository.  It is a good discipline.
51
52 Give an explanation for the change(s) that is detailed enough so
53 that people can judge if it is good thing to do, without reading
54 the actual patch text to determine how well the code does what
55 the explanation promises to do.
56
57 If your description starts to get too long, that's a sign that you
58 probably need to split up your commit to finer grained pieces.
59 That being said, patches which plainly describe the things that
60 help reviewers check the patch, and future maintainers understand
61 the code, are the most beautiful patches.  Descriptions that summarize
62 the point in the subject well, and describe the motivation for the
63 change, the approach taken by the change, and if relevant how this
64 differs substantially from the prior version, are all good things
65 to have.
66
67 Make sure that you have tests for the bug you are fixing.  See
68 `t/README` for guidance.
69
70 [[tests]]
71 When adding a new feature, make sure that you have new tests to show
72 the feature triggers the new behavior when it should, and to show the
73 feature does not trigger when it shouldn't.  After any code change, make
74 sure that the entire test suite passes.
75
76 If you have an account at GitHub (and you can get one for free to work
77 on open source projects), you can use their Travis CI integration to
78 test your changes on Linux, Mac (and hopefully soon Windows).  See
79 GitHub-Travis CI hints section for details.
80
81 Do not forget to update the documentation to describe the updated
82 behavior and make sure that the resulting documentation set formats
83 well (try the Documentation/doc-diff script).
84
85 We currently have a liberal mixture of US and UK English norms for
86 spelling and grammar, which is somewhat unfortunate.  A huge patch that
87 touches the files all over the place only to correct the inconsistency
88 is not welcome, though.  Potential clashes with other changes that can
89 result from such a patch are not worth it.  We prefer to gradually
90 reconcile the inconsistencies in favor of US English, with small and
91 easily digestible patches, as a side effect of doing some other real
92 work in the vicinity (e.g. rewriting a paragraph for clarity, while
93 turning en_UK spelling to en_US).  Obvious typographical fixes are much
94 more welcomed ("teh -> "the"), preferably submitted as independent
95 patches separate from other documentation changes.
96
97 [[whitespace-check]]
98 Oh, another thing.  We are picky about whitespaces.  Make sure your
99 changes do not trigger errors with the sample pre-commit hook shipped
100 in `templates/hooks--pre-commit`.  To help ensure this does not happen,
101 run `git diff --check` on your changes before you commit.
102
103 [[describe-changes]]
104 === Describe your changes well.
105
106 The first line of the commit message should be a short description (50
107 characters is the soft limit, see DISCUSSION in linkgit:git-commit[1]),
108 and should skip the full stop.  It is also conventional in most cases to
109 prefix the first line with "area: " where the area is a filename or
110 identifier for the general area of the code being modified, e.g.
111
112 * doc: clarify distinction between sign-off and pgp-signing
113 * githooks.txt: improve the intro section
114
115 If in doubt which identifier to use, run `git log --no-merges` on the
116 files you are modifying to see the current conventions.
117
118 [[summary-section]]
119 It's customary to start the remainder of the first line after "area: "
120 with a lower-case letter. E.g. "doc: clarify...", not "doc:
121 Clarify...", or "githooks.txt: improve...", not "githooks.txt:
122 Improve...".
123
124 [[meaningful-message]]
125 The body should provide a meaningful commit message, which:
126
127 . explains the problem the change tries to solve, i.e. what is wrong
128   with the current code without the change.
129
130 . justifies the way the change solves the problem, i.e. why the
131   result with the change is better.
132
133 . alternate solutions considered but discarded, if any.
134
135 [[imperative-mood]]
136 Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
137 instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
138 to do frotz", as if you are giving orders to the codebase to change
139 its behavior.  Try to make sure your explanation can be understood
140 without external resources. Instead of giving a URL to a mailing list
141 archive, summarize the relevant points of the discussion.
142
143 [[commit-reference]]
144 If you want to reference a previous commit in the history of a stable
145 branch, use the format "abbreviated hash (subject, date)", like this:
146
147 ....
148         Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)
149         noticed that ...
150 ....
151
152 The "Copy commit summary" command of gitk can be used to obtain this
153 format (with the subject enclosed in a pair of double-quotes), or this
154 invocation of `git show`:
155
156 ....
157         git show -s --pretty=reference <commit>
158 ....
159
160 or, on an older version of Git without support for --pretty=reference:
161
162 ....
163         git show -s --date=short --pretty='format:%h (%s, %ad)' <commit>
164 ....
165
166 [[git-tools]]
167 === Generate your patch using Git tools out of your commits.
168
169 Git based diff tools generate unidiff which is the preferred format.
170
171 You do not have to be afraid to use `-M` option to `git diff` or
172 `git format-patch`, if your patch involves file renames.  The
173 receiving end can handle them just fine.
174
175 [[review-patch]]
176 Please make sure your patch does not add commented out debugging code,
177 or include any extra files which do not relate to what your patch
178 is trying to achieve. Make sure to review
179 your patch after generating it, to ensure accuracy.  Before
180 sending out, please make sure it cleanly applies to the `master`
181 branch head.  If you are preparing a work based on "next" branch,
182 that is fine, but please mark it as such.
183
184 [[send-patches]]
185 === Sending your patches.
186
187 :security-ml: footnoteref:[security-ml,The Git Security mailing list: git-security@googlegroups.com]
188
189 Before sending any patches, please note that patches that may be
190 security relevant should be submitted privately to the Git Security
191 mailing list{security-ml}, instead of the public mailing list.
192
193 Learn to use format-patch and send-email if possible.  These commands
194 are optimized for the workflow of sending patches, avoiding many ways
195 your existing e-mail client that is optimized for "multipart/*" mime
196 type e-mails to corrupt and render your patches unusable.
197
198 People on the Git mailing list need to be able to read and
199 comment on the changes you are submitting.  It is important for
200 a developer to be able to "quote" your changes, using standard
201 e-mail tools, so that they may comment on specific portions of
202 your code.  For this reason, each patch should be submitted
203 "inline" in a separate message.
204
205 Multiple related patches should be grouped into their own e-mail
206 thread to help readers find all parts of the series.  To that end,
207 send them as replies to either an additional "cover letter" message
208 (see below), the first patch, or the respective preceding patch.
209
210 If your log message (including your name on the
211 Signed-off-by line) is not writable in ASCII, make sure that
212 you send off a message in the correct encoding.
213
214 WARNING: Be wary of your MUAs word-wrap
215 corrupting your patch.  Do not cut-n-paste your patch; you can
216 lose tabs that way if you are not careful.
217
218 It is a common convention to prefix your subject line with
219 [PATCH].  This lets people easily distinguish patches from other
220 e-mail discussions.  Use of markers in addition to PATCH within
221 the brackets to describe the nature of the patch is also
222 encouraged.  E.g. [RFC PATCH] (where RFC stands for "request for
223 comments") is often used to indicate a patch needs further
224 discussion before being accepted, [PATCH v2], [PATCH v3] etc.
225 are often seen when you are sending an update to what you have
226 previously sent.
227
228 The `git format-patch` command follows the best current practice to
229 format the body of an e-mail message.  At the beginning of the
230 patch should come your commit message, ending with the
231 Signed-off-by: lines, and a line that consists of three dashes,
232 followed by the diffstat information and the patch itself.  If
233 you are forwarding a patch from somebody else, optionally, at
234 the beginning of the e-mail message just before the commit
235 message starts, you can put a "From: " line to name that person.
236 To change the default "[PATCH]" in the subject to "[<text>]", use
237 `git format-patch --subject-prefix=<text>`.  As a shortcut, you
238 can use `--rfc` instead of `--subject-prefix="RFC PATCH"`, or
239 `-v <n>` instead of `--subject-prefix="PATCH v<n>"`.
240
241 You often want to add additional explanation about the patch,
242 other than the commit message itself.  Place such "cover letter"
243 material between the three-dash line and the diffstat.  For
244 patches requiring multiple iterations of review and discussion,
245 an explanation of changes between each iteration can be kept in
246 Git-notes and inserted automatically following the three-dash
247 line via `git format-patch --notes`.
248
249 [[attachment]]
250 Do not attach the patch as a MIME attachment, compressed or not.
251 Do not let your e-mail client send quoted-printable.  Do not let
252 your e-mail client send format=flowed which would destroy
253 whitespaces in your patches. Many
254 popular e-mail applications will not always transmit a MIME
255 attachment as plain text, making it impossible to comment on
256 your code.  A MIME attachment also takes a bit more time to
257 process.  This does not decrease the likelihood of your
258 MIME-attached change being accepted, but it makes it more likely
259 that it will be postponed.
260
261 Exception:  If your mailer is mangling patches then someone may ask
262 you to re-send them using MIME, that is OK.
263
264 [[pgp-signature]]
265 Do not PGP sign your patch. Most likely, your maintainer or other people on the
266 list would not have your PGP key and would not bother obtaining it anyway.
267 Your patch is not judged by who you are; a good patch from an unknown origin
268 has a far better chance of being accepted than a patch from a known, respected
269 origin that is done poorly or does incorrect things.
270
271 If you really really really really want to do a PGP signed
272 patch, format it as "multipart/signed", not a text/plain message
273 that starts with `-----BEGIN PGP SIGNED MESSAGE-----`.  That is
274 not a text/plain, it's something else.
275
276 :security-ml-ref: footnoteref:[security-ml]
277
278 As mentioned at the beginning of the section, patches that may be
279 security relevant should not be submitted to the public mailing list
280 mentioned below, but should instead be sent privately to the Git
281 Security mailing list{security-ml-ref}.
282
283 Send your patch with "To:" set to the mailing list, with "cc:" listing
284 people who are involved in the area you are touching (the `git
285 contacts` command in `contrib/contacts/` can help to
286 identify them), to solicit comments and reviews.
287
288 :current-maintainer: footnote:[The current maintainer: gitster@pobox.com]
289 :git-ml: footnote:[The mailing list: git@vger.kernel.org]
290
291 After the list reached a consensus that it is a good idea to apply the
292 patch, re-send it with "To:" set to the maintainer{current-maintainer} and "cc:" the
293 list{git-ml} for inclusion.
294
295 Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and
296 `Tested-by:` lines as necessary to credit people who helped your
297 patch.
298
299 [[sign-off]]
300 === Certify your work by adding your "Signed-off-by: " line
301
302 To improve tracking of who did what, we've borrowed the
303 "sign-off" procedure from the Linux kernel project on patches
304 that are being emailed around.  Although core Git is a lot
305 smaller project it is a good discipline to follow it.
306
307 The sign-off is a simple line at the end of the explanation for
308 the patch, which certifies that you wrote it or otherwise have
309 the right to pass it on as an open-source patch.  The rules are
310 pretty simple: if you can certify the below D-C-O:
311
312 [[dco]]
313 .Developer's Certificate of Origin 1.1
314 ____
315 By making a contribution to this project, I certify that:
316
317 a. The contribution was created in whole or in part by me and I
318    have the right to submit it under the open source license
319    indicated in the file; or
320
321 b. The contribution is based upon previous work that, to the best
322    of my knowledge, is covered under an appropriate open source
323    license and I have the right under that license to submit that
324    work with modifications, whether created in whole or in part
325    by me, under the same open source license (unless I am
326    permitted to submit under a different license), as indicated
327    in the file; or
328
329 c. The contribution was provided directly to me by some other
330    person who certified (a), (b) or (c) and I have not modified
331    it.
332
333 d. I understand and agree that this project and the contribution
334    are public and that a record of the contribution (including all
335    personal information I submit with it, including my sign-off) is
336    maintained indefinitely and may be redistributed consistent with
337    this project or the open source license(s) involved.
338 ____
339
340 then you just add a line saying
341
342 ....
343         Signed-off-by: Random J Developer <random@developer.example.org>
344 ....
345
346 This line can be automatically added by Git if you run the git-commit
347 command with the -s option.
348
349 Notice that you can place your own Signed-off-by: line when
350 forwarding somebody else's patch with the above rules for
351 D-C-O.  Indeed you are encouraged to do so.  Do not forget to
352 place an in-body "From: " line at the beginning to properly attribute
353 the change to its true author (see (2) above).
354
355 [[real-name]]
356 Also notice that a real name is used in the Signed-off-by: line. Please
357 don't hide your real name.
358
359 [[commit-trailers]]
360 If you like, you can put extra tags at the end:
361
362 . `Reported-by:` is used to credit someone who found the bug that
363   the patch attempts to fix.
364 . `Acked-by:` says that the person who is more familiar with the area
365   the patch attempts to modify liked the patch.
366 . `Reviewed-by:`, unlike the other tags, can only be offered by the
367   reviewer and means that she is completely satisfied that the patch
368   is ready for application.  It is usually offered only after a
369   detailed review.
370 . `Tested-by:` is used to indicate that the person applied the patch
371   and found it to have the desired effect.
372
373 You can also create your own tag or use one that's in common usage
374 such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
375
376 == Subsystems with dedicated maintainers
377
378 Some parts of the system have dedicated maintainers with their own
379 repositories.
380
381 - `git-gui/` comes from git-gui project, maintained by Pratyush Yadav:
382
383         https://github.com/prati0100/git-gui.git
384
385 - `gitk-git/` comes from Paul Mackerras's gitk project:
386
387         git://ozlabs.org/~paulus/gitk
388
389 - `po/` comes from the localization coordinator, Jiang Xin:
390
391         https://github.com/git-l10n/git-po/
392
393 Patches to these parts should be based on their trees.
394
395 [[patch-flow]]
396 == An ideal patch flow
397
398 Here is an ideal patch flow for this project the current maintainer
399 suggests to the contributors:
400
401 . You come up with an itch.  You code it up.
402
403 . Send it to the list and cc people who may need to know about
404   the change.
405 +
406 The people who may need to know are the ones whose code you
407 are butchering.  These people happen to be the ones who are
408 most likely to be knowledgeable enough to help you, but
409 they have no obligation to help you (i.e. you ask for help,
410 don't demand).  +git log -p {litdd} _$area_you_are_modifying_+ would
411 help you find out who they are.
412
413 . You get comments and suggestions for improvements.  You may
414   even get them in an "on top of your change" patch form.
415
416 . Polish, refine, and re-send to the list and the people who
417   spend their time to improve your patch.  Go back to step (2).
418
419 . The list forms consensus that the last round of your patch is
420   good.  Send it to the maintainer and cc the list.
421
422 . A topic branch is created with the patch and is merged to `next`,
423   and cooked further and eventually graduates to `master`.
424
425 In any time between the (2)-(3) cycle, the maintainer may pick it up
426 from the list and queue it to `pu`, in order to make it easier for
427 people play with it without having to pick up and apply the patch to
428 their trees themselves.
429
430 [[patch-status]]
431 == Know the status of your patch after submission
432
433 * You can use Git itself to find out when your patch is merged in
434   master. `git pull --rebase` will automatically skip already-applied
435   patches, and will let you know. This works only if you rebase on top
436   of the branch in which your patch has been merged (i.e. it will not
437   tell you if your patch is merged in pu if you rebase on top of
438   master).
439
440 * Read the Git mailing list, the maintainer regularly posts messages
441   entitled "What's cooking in git.git" and "What's in git.git" giving
442   the status of various proposed changes.
443
444 [[travis]]
445 == GitHub-Travis CI hints
446
447 With an account at GitHub (you can get one for free to work on open
448 source projects), you can use Travis CI to test your changes on Linux,
449 Mac (and hopefully soon Windows).  You can find a successful example
450 test build here: https://travis-ci.org/git/git/builds/120473209
451
452 Follow these steps for the initial setup:
453
454 . Fork https://github.com/git/git to your GitHub account.
455   You can find detailed instructions how to fork here:
456   https://help.github.com/articles/fork-a-repo/
457
458 . Open the Travis CI website: https://travis-ci.org
459
460 . Press the "Sign in with GitHub" button.
461
462 . Grant Travis CI permissions to access your GitHub account.
463   You can find more information about the required permissions here:
464   https://docs.travis-ci.com/user/github-oauth-scopes
465
466 . Open your Travis CI profile page: https://travis-ci.org/profile
467
468 . Enable Travis CI builds for your Git fork.
469
470 After the initial setup, Travis CI will run whenever you push new changes
471 to your fork of Git on GitHub.  You can monitor the test state of all your
472 branches here: https://travis-ci.org/__<Your GitHub handle>__/git/branches
473
474 If a branch did not pass all test cases then it is marked with a red
475 cross.  In that case you can click on the failing Travis CI job and
476 scroll all the way down in the log.  Find the line "<-- Click here to see
477 detailed test output!" and click on the triangle next to the log line
478 number to expand the detailed test output.  Here is such a failing
479 example: https://travis-ci.org/git/git/jobs/122676187
480
481 Fix the problem and push your fix to your Git fork.  This will trigger
482 a new Travis CI build to ensure all tests pass.
483
484 [[mua]]
485 == MUA specific hints
486
487 Some of patches I receive or pick up from the list share common
488 patterns of breakage.  Please make sure your MUA is set up
489 properly not to corrupt whitespaces.
490
491 See the DISCUSSION section of linkgit:git-format-patch[1] for hints on
492 checking your patch by mailing it to yourself and applying with
493 linkgit:git-am[1].
494
495 While you are at it, check the resulting commit log message from
496 a trial run of applying the patch.  If what is in the resulting
497 commit is not exactly what you would want to see, it is very
498 likely that your maintainer would end up hand editing the log
499 message when he applies your patch.  Things like "Hi, this is my
500 first patch.\n", if you really want to put in the patch e-mail,
501 should come after the three-dash line that signals the end of the
502 commit message.
503
504
505 === Pine
506
507 (Johannes Schindelin)
508
509 ....
510 I don't know how many people still use pine, but for those poor
511 souls it may be good to mention that the quell-flowed-text is
512 needed for recent versions.
513
514 ... the "no-strip-whitespace-before-send" option, too. AFAIK it
515 was introduced in 4.60.
516 ....
517
518 (Linus Torvalds)
519
520 ....
521 And 4.58 needs at least this.
522
523 diff-tree 8326dd8350be64ac7fc805f6563a1d61ad10d32c (from e886a61f76edf5410573e92e38ce22974f9c40f1)
524 Author: Linus Torvalds <torvalds@g5.osdl.org>
525 Date:   Mon Aug 15 17:23:51 2005 -0700
526
527     Fix pine whitespace-corruption bug
528
529     There's no excuse for unconditionally removing whitespace from
530     the pico buffers on close.
531
532 diff --git a/pico/pico.c b/pico/pico.c
533 --- a/pico/pico.c
534 +++ b/pico/pico.c
535 @@ -219,7 +219,9 @@ PICO *pm;
536             switch(pico_all_done){      /* prepare for/handle final events */
537               case COMP_EXIT :          /* already confirmed */
538                 packheader();
539 +#if 0
540                 stripwhitespace();
541 +#endif
542                 c |= COMP_EXIT;
543                 break;
544 ....
545
546 (Daniel Barkalow)
547
548 ....
549 > A patch to SubmittingPatches, MUA specific help section for
550 > users of Pine 4.63 would be very much appreciated.
551
552 Ah, it looks like a recent version changed the default behavior to do the
553 right thing, and inverted the sense of the configuration option. (Either
554 that or Gentoo did it.) So you need to set the
555 "no-strip-whitespace-before-send" option, unless the option you have is
556 "strip-whitespace-before-send", in which case you should avoid checking
557 it.
558 ....
559
560 === Thunderbird, KMail, GMail
561
562 See the MUA-SPECIFIC HINTS section of linkgit:git-format-patch[1].
563
564 === Gnus
565
566 "|" in the `*Summary*` buffer can be used to pipe the current
567 message to an external program, and this is a handy way to drive
568 `git am`.  However, if the message is MIME encoded, what is
569 piped into the program is the representation you see in your
570 `*Article*` buffer after unwrapping MIME.  This is often not what
571 you would want for two reasons.  It tends to screw up non ASCII
572 characters (most notably in people's names), and also
573 whitespaces (fatal in patches).  Running "C-u g" to display the
574 message in raw form before using "|" to run the pipe can work
575 this problem around.