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