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