Sixth batch of topics for 2.10
[git.git] / Documentation / SubmittingPatches
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 behavior when it should, and to show the
65 feature does not trigger when it shouldn't.  After any code change, make
66 sure that the entire test suite passes.
68 If you have an account at GitHub (and you can get one for free to work
69 on open source projects), you can use their Travis CI integration to
70 test your changes on Linux, Mac (and hopefully soon Windows).  See
71 GitHub-Travis CI hints section for details.
73 Do not forget to update the documentation to describe the updated
74 behavior and make sure that the resulting documentation set formats
75 well. It is currently a liberal mixture of US and UK English norms for
76 spelling and grammar, which is somewhat unfortunate.  A huge patch that
77 touches the files all over the place only to correct the inconsistency
78 is not welcome, though.  Potential clashes with other changes that can
79 result from such a patch are not worth it.  We prefer to gradually
80 reconcile the inconsistencies in favor of US English, with small and
81 easily digestible patches, as a side effect of doing some other real
82 work in the vicinity (e.g. rewriting a paragraph for clarity, while
83 turning en_UK spelling to en_US).  Obvious typographical fixes are much
84 more welcomed ("teh -> "the"), preferably submitted as independent
85 patches separate from other documentation changes.
87 Oh, another thing.  We are picky about whitespaces.  Make sure your
88 changes do not trigger errors with the sample pre-commit hook shipped
89 in templates/hooks--pre-commit.  To help ensure this does not happen,
90 run git diff --check on your changes before you commit.
93 (2) Describe your changes well.
95 The first line of the commit message should be a short description (50
96 characters is the soft limit, see DISCUSSION in git-commit(1)), and
97 should skip the full stop.  It is also conventional in most cases to
98 prefix the first line with "area: " where the area is a filename or
99 identifier for the general area of the code being modified, e.g.
101   . archive: ustar header checksum is computed unsigned
102   . git-cherry-pick.txt: clarify the use of revision range notation
104 If in doubt which identifier to use, run "git log --no-merges" on the
105 files you are modifying to see the current conventions.
107 The body should provide a meaningful commit message, which:
109   . explains the problem the change tries to solve, iow, what is wrong
110     with the current code without the change.
112   . justifies the way the change solves the problem, iow, why the
113     result with the change is better.
115   . alternate solutions considered but discarded, if any.
117 Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
118 instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
119 to do frotz", as if you are giving orders to the codebase to change
120 its behaviour.  Try to make sure your explanation can be understood
121 without external resources. Instead of giving a URL to a mailing list
122 archive, summarize the relevant points of the discussion.
125 (3) Generate your patch using Git tools out of your commits.
127 Git based diff tools generate unidiff which is the preferred format.
129 You do not have to be afraid to use -M option to "git diff" or
130 "git format-patch", if your patch involves file renames.  The
131 receiving end can handle them just fine.
133 Please make sure your patch does not add commented out debugging code,
134 or include any extra files which do not relate to what your patch
135 is trying to achieve. Make sure to review
136 your patch after generating it, to ensure accuracy.  Before
137 sending out, please make sure it cleanly applies to the "master"
138 branch head.  If you are preparing a work based on "next" branch,
139 that is fine, but please mark it as such.
142 (4) Sending your patches.
144 Learn to use format-patch and send-email if possible.  These commands
145 are optimized for the workflow of sending patches, avoiding many ways
146 your existing e-mail client that is optimized for "multipart/*" mime
147 type e-mails to corrupt and render your patches unusable.
149 People on the Git mailing list need to be able to read and
150 comment on the changes you are submitting.  It is important for
151 a developer to be able to "quote" your changes, using standard
152 e-mail tools, so that they may comment on specific portions of
153 your code.  For this reason, each patch should be submitted
154 "inline" in a separate message.
156 Multiple related patches should be grouped into their own e-mail
157 thread to help readers find all parts of the series.  To that end,
158 send them as replies to either an additional "cover letter" message
159 (see below), the first patch, or the respective preceding patch.
161 If your log message (including your name on the
162 Signed-off-by line) is not writable in ASCII, make sure that
163 you send off a message in the correct encoding.
165 WARNING: Be wary of your MUAs word-wrap
166 corrupting your patch.  Do not cut-n-paste your patch; you can
167 lose tabs that way if you are not careful.
169 It is a common convention to prefix your subject line with
170 [PATCH].  This lets people easily distinguish patches from other
171 e-mail discussions.  Use of additional markers after PATCH and
172 the closing bracket to mark the nature of the patch is also
173 encouraged.  E.g. [PATCH/RFC] is often used when the patch is
174 not ready to be applied but it is for discussion, [PATCH v2],
175 [PATCH v3] etc. are often seen when you are sending an update to
176 what you have previously sent.
178 "git format-patch" command follows the best current practice to
179 format the body of an e-mail message.  At the beginning of the
180 patch should come your commit message, ending with the
181 Signed-off-by: lines, and a line that consists of three dashes,
182 followed by the diffstat information and the patch itself.  If
183 you are forwarding a patch from somebody else, optionally, at
184 the beginning of the e-mail message just before the commit
185 message starts, you can put a "From: " line to name that person.
187 You often want to add additional explanation about the patch,
188 other than the commit message itself.  Place such "cover letter"
189 material between the three-dash line and the diffstat.  For
190 patches requiring multiple iterations of review and discussion,
191 an explanation of changes between each iteration can be kept in
192 Git-notes and inserted automatically following the three-dash
193 line via `git format-patch --notes`.
195 Do not attach the patch as a MIME attachment, compressed or not.
196 Do not let your e-mail client send quoted-printable.  Do not let
197 your e-mail client send format=flowed which would destroy
198 whitespaces in your patches. Many
199 popular e-mail applications will not always transmit a MIME
200 attachment as plain text, making it impossible to comment on
201 your code.  A MIME attachment also takes a bit more time to
202 process.  This does not decrease the likelihood of your
203 MIME-attached change being accepted, but it makes it more likely
204 that it will be postponed.
206 Exception:  If your mailer is mangling patches then someone may ask
207 you to re-send them using MIME, that is OK.
209 Do not PGP sign your patch, at least for now.  Most likely, your
210 maintainer or other people on the list would not have your PGP
211 key and would not bother obtaining it anyway.  Your patch is not
212 judged by who you are; a good patch from an unknown origin has a
213 far better chance of being accepted than a patch from a known,
214 respected origin that is done poorly or does incorrect things.
216 If you really really really really want to do a PGP signed
217 patch, format it as "multipart/signed", not a text/plain message
218 that starts with '-----BEGIN PGP SIGNED MESSAGE-----'.  That is
219 not a text/plain, it's something else.
221 Send your patch with "To:" set to the mailing list, with "cc:" listing
222 people who are involved in the area you are touching (the output from
223 "git blame $path" and "git shortlog --no-merges $path" would help to
224 identify them), to solicit comments and reviews.
226 After the list reached a consensus that it is a good idea to apply the
227 patch, re-send it with "To:" set to the maintainer [*1*] and "cc:" the
228 list [*2*] for inclusion.
230 Do not forget to add trailers such as "Acked-by:", "Reviewed-by:" and
231 "Tested-by:" lines as necessary to credit people who helped your
232 patch.
234     [Addresses]
235      *1* The current maintainer:
236      *2* The mailing list:
239 (5) Sign your work
241 To improve tracking of who did what, we've borrowed the
242 "sign-off" procedure from the Linux kernel project on patches
243 that are being emailed around.  Although core Git is a lot
244 smaller project it is a good discipline to follow it.
246 The sign-off is a simple line at the end of the explanation for
247 the patch, which certifies that you wrote it or otherwise have
248 the right to pass it on as a open-source patch.  The rules are
249 pretty simple: if you can certify the below:
251         Developer's Certificate of Origin 1.1
253         By making a contribution to this project, I certify that:
255         (a) The contribution was created in whole or in part by me and I
256             have the right to submit it under the open source license
257             indicated in the file; or
259         (b) The contribution is based upon previous work that, to the best
260             of my knowledge, is covered under an appropriate open source
261             license and I have the right under that license to submit that
262             work with modifications, whether created in whole or in part
263             by me, under the same open source license (unless I am
264             permitted to submit under a different license), as indicated
265             in the file; or
267         (c) The contribution was provided directly to me by some other
268             person who certified (a), (b) or (c) and I have not modified
269             it.
271         (d) I understand and agree that this project and the contribution
272             are public and that a record of the contribution (including all
273             personal information I submit with it, including my sign-off) is
274             maintained indefinitely and may be redistributed consistent with
275             this project or the open source license(s) involved.
277 then you just add a line saying
279         Signed-off-by: Random J Developer <>
281 This line can be automatically added by Git if you run the git-commit
282 command with the -s option.
284 Notice that you can place your own Signed-off-by: line when
285 forwarding somebody else's patch with the above rules for
286 D-C-O.  Indeed you are encouraged to do so.  Do not forget to
287 place an in-body "From: " line at the beginning to properly attribute
288 the change to its true author (see (2) above).
290 Also notice that a real name is used in the Signed-off-by: line. Please
291 don't hide your real name.
293 If you like, you can put extra tags at the end:
295 1. "Reported-by:" is used to credit someone who found the bug that
296    the patch attempts to fix.
297 2. "Acked-by:" says that the person who is more familiar with the area
298    the patch attempts to modify liked the patch.
299 3. "Reviewed-by:", unlike the other tags, can only be offered by the
300    reviewer and means that she is completely satisfied that the patch
301    is ready for application.  It is usually offered only after a
302    detailed review.
303 4. "Tested-by:" is used to indicate that the person applied the patch
304    and found it to have the desired effect.
306 You can also create your own tag or use one that's in common usage
307 such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
309 ------------------------------------------------
310 Subsystems with dedicated maintainers
312 Some parts of the system have dedicated maintainers with their own
313 repositories.
315  - git-gui/ comes from git-gui project, maintained by Pat Thoyts:
317         git://
319  - gitk-git/ comes from Paul Mackerras's gitk project:
321         git://
323  - po/ comes from the localization coordinator, Jiang Xin:
327 Patches to these parts should be based on their trees.
329 ------------------------------------------------
330 An ideal patch flow
332 Here is an ideal patch flow for this project the current maintainer
333 suggests to the contributors:
335  (0) You come up with an itch.  You code it up.
337  (1) Send it to the list and cc people who may need to know about
338      the change.
340      The people who may need to know are the ones whose code you
341      are butchering.  These people happen to be the ones who are
342      most likely to be knowledgeable enough to help you, but
343      they have no obligation to help you (i.e. you ask for help,
344      don't demand).  "git log -p -- $area_you_are_modifying" would
345      help you find out who they are.
347  (2) You get comments and suggestions for improvements.  You may
348      even get them in a "on top of your change" patch form.
350  (3) Polish, refine, and re-send to the list and the people who
351      spend their time to improve your patch.  Go back to step (2).
353  (4) The list forms consensus that the last round of your patch is
354      good.  Send it to the maintainer and cc the list.
356  (5) A topic branch is created with the patch and is merged to 'next',
357      and cooked further and eventually graduates to 'master'.
359 In any time between the (2)-(3) cycle, the maintainer may pick it up
360 from the list and queue it to 'pu', in order to make it easier for
361 people play with it without having to pick up and apply the patch to
362 their trees themselves.
364 ------------------------------------------------
365 Know the status of your patch after submission
367 * You can use Git itself to find out when your patch is merged in
368   master. 'git pull --rebase' will automatically skip already-applied
369   patches, and will let you know. This works only if you rebase on top
370   of the branch in which your patch has been merged (i.e. it will not
371   tell you if your patch is merged in pu if you rebase on top of
372   master).
374 * Read the Git mailing list, the maintainer regularly posts messages
375   entitled "What's cooking in git.git" and "What's in git.git" giving
376   the status of various proposed changes.
378 --------------------------------------------------
379 GitHub-Travis CI hints
381 With an account at GitHub (you can get one for free to work on open
382 source projects), you can use Travis CI to test your changes on Linux,
383 Mac (and hopefully soon Windows).  You can find a successful example
384 test build here:
386 Follow these steps for the initial setup:
388  (1) Fork to your GitHub account.
389      You can find detailed instructions how to fork here:
392  (2) Open the Travis CI website:
394  (3) Press the "Sign in with GitHub" button.
396  (4) Grant Travis CI permissions to access your GitHub account.
397      You can find more information about the required permissions here:
400  (5) Open your Travis CI profile page:
402  (6) Enable Travis CI builds for your Git fork.
404 After the initial setup, Travis CI will run whenever you push new changes
405 to your fork of Git on GitHub.  You can monitor the test state of all your
406 branches here:<Your GitHub handle>/git/branches
408 If a branch did not pass all test cases then it is marked with a red
409 cross.  In that case you can click on the failing Travis CI job and
410 scroll all the way down in the log.  Find the line "<-- Click here to see
411 detailed test output!" and click on the triangle next to the log line
412 number to expand the detailed test output.  Here is such a failing
413 example:
415 Fix the problem and push your fix to your Git fork.  This will trigger
416 a new Travis CI build to ensure all tests pass.
419 ------------------------------------------------
420 MUA specific hints
422 Some of patches I receive or pick up from the list share common
423 patterns of breakage.  Please make sure your MUA is set up
424 properly not to corrupt whitespaces.
426 See the DISCUSSION section of git-format-patch(1) for hints on
427 checking your patch by mailing it to yourself and applying with
428 git-am(1).
430 While you are at it, check the resulting commit log message from
431 a trial run of applying the patch.  If what is in the resulting
432 commit is not exactly what you would want to see, it is very
433 likely that your maintainer would end up hand editing the log
434 message when he applies your patch.  Things like "Hi, this is my
435 first patch.\n", if you really want to put in the patch e-mail,
436 should come after the three-dash line that signals the end of the
437 commit message.
440 Pine
441 ----
443 (Johannes Schindelin)
445 I don't know how many people still use pine, but for those poor
446 souls it may be good to mention that the quell-flowed-text is
447 needed for recent versions.
449 ... the "no-strip-whitespace-before-send" option, too. AFAIK it
450 was introduced in 4.60.
452 (Linus Torvalds)
454 And 4.58 needs at least this.
457 diff-tree 8326dd8350be64ac7fc805f6563a1d61ad10d32c (from e886a61f76edf5410573e92e38ce22974f9c40f1)
458 Author: Linus Torvalds <>
459 Date:   Mon Aug 15 17:23:51 2005 -0700
461     Fix pine whitespace-corruption bug
463     There's no excuse for unconditionally removing whitespace from
464     the pico buffers on close.
466 diff --git a/pico/pico.c b/pico/pico.c
467 --- a/pico/pico.c
468 +++ b/pico/pico.c
469 @@ -219,7 +219,9 @@ PICO *pm;
470             switch(pico_all_done){      /* prepare for/handle final events */
471               case COMP_EXIT :          /* already confirmed */
472                 packheader();
473 +#if 0
474                 stripwhitespace();
475 +#endif
476                 c |= COMP_EXIT;
477                 break;
480 (Daniel Barkalow)
482 > A patch to SubmittingPatches, MUA specific help section for
483 > users of Pine 4.63 would be very much appreciated.
485 Ah, it looks like a recent version changed the default behavior to do the
486 right thing, and inverted the sense of the configuration option. (Either
487 that or Gentoo did it.) So you need to set the
488 "no-strip-whitespace-before-send" option, unless the option you have is
489 "strip-whitespace-before-send", in which case you should avoid checking
493 Thunderbird, KMail, GMail
494 -------------------------
496 See the MUA-SPECIFIC HINTS section of git-format-patch(1).
498 Gnus
499 ----
501 '|' in the *Summary* buffer can be used to pipe the current
502 message to an external program, and this is a handy way to drive
503 "git am".  However, if the message is MIME encoded, what is
504 piped into the program is the representation you see in your
505 *Article* buffer after unwrapping MIME.  This is often not what
506 you would want for two reasons.  It tends to screw up non ASCII
507 characters (most notably in people's names), and also
508 whitespaces (fatal in patches).  Running 'C-u g' to display the
509 message in raw form before using '|' to run the pipe can work
510 this problem around.