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