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