]>
Commit | Line | Data |
---|---|---|
049e64aa | 1 | Submitting Patches |
2 | ================== | |
3 | ||
4 | == Guidelines | |
5 | ||
b75a2199 ES |
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. | |
31408251 | 9 | |
049e64aa | 10 | [[base-branch]] |
11 | === Decide what to base your work on. | |
d0c26f0f RR |
12 | |
13 | In general, always base your work on the oldest branch that your | |
14 | change is relevant to. | |
15 | ||
049e64aa | 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. | |
d0c26f0f | 20 | |
049e64aa | 21 | * A new feature should be based on `master` in general. If the new |
828197de | 22 | feature depends on a topic that is in `seen`, but not in `master`, |
049e64aa | 23 | base your work on the tip of that topic. |
d0c26f0f | 24 | |
049e64aa | 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. | |
d0c26f0f | 29 | |
049e64aa | 30 | * In the exceptional case that a new feature depends on several topics |
828197de | 31 | not in `master`, start working on `next` or `seen` privately and send |
049e64aa | 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. | |
d0c26f0f | 35 | |
049e64aa | 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. | |
e6da8ee8 | 39 | |
049e64aa | 40 | To find the tip of a topic branch, run `git log --first-parent |
828197de | 41 | master..seen` and look for the merge commit. The second parent of this |
d0c26f0f | 42 | commit is the tip of the topic branch. |
31408251 | 43 | |
049e64aa | 44 | [[separate-commits]] |
45 | === Make separate commits for logically separate changes. | |
31408251 JH |
46 | |
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. | |
52 | ||
d0f7dcbf JH |
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. | |
31408251 | 57 | |
45d2b286 | 58 | If your description starts to get too long, that's a sign that you |
31408251 | 59 | probably need to split up your commit to finer grained pieces. |
47afed5d SV |
60 | That being said, patches which plainly describe the things that |
61 | help reviewers check the patch, and future maintainers understand | |
01e60a9a | 62 | the code, are the most beautiful patches. Descriptions that summarize |
47afed5d SV |
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 | |
d0f7dcbf JH |
65 | differs substantially from the prior version, are all good things |
66 | to have. | |
31408251 | 67 | |
54cc5d29 | 68 | Make sure that you have tests for the bug you are fixing. See |
049e64aa | 69 | `t/README` for guidance. |
7d5bf87b | 70 | |
049e64aa | 71 | [[tests]] |
7d5bf87b | 72 | When adding a new feature, make sure that you have new tests to show |
0e5d028a LS |
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. | |
76 | ||
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. | |
81 | ||
82 | Do not forget to update the documentation to describe the updated | |
83 | behavior and make sure that the resulting documentation set formats | |
7a76f5c6 JK |
84 | well (try the Documentation/doc-diff script). |
85 | ||
86 | We currently have a liberal mixture of US and UK English norms for | |
0e5d028a LS |
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. | |
42e0fae9 | 97 | |
049e64aa | 98 | [[whitespace-check]] |
42e0fae9 | 99 | Oh, another thing. We are picky about whitespaces. Make sure your |
45d2b286 | 100 | changes do not trigger errors with the sample pre-commit hook shipped |
049e64aa | 101 | in `templates/hooks--pre-commit`. To help ensure this does not happen, |
102 | run `git diff --check` on your changes before you commit. | |
31408251 | 103 | |
049e64aa | 104 | [[describe-changes]] |
105 | === Describe your changes well. | |
7d5bf87b JH |
106 | |
107 | The first line of the commit message should be a short description (50 | |
049e64aa | 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 | |
7d5bf87b JH |
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. | |
112 | ||
049e64aa | 113 | * doc: clarify distinction between sign-off and pgp-signing |
114 | * githooks.txt: improve the intro section | |
7d5bf87b | 115 | |
049e64aa | 116 | If in doubt which identifier to use, run `git log --no-merges` on the |
7d5bf87b JH |
117 | files you are modifying to see the current conventions. |
118 | ||
049e64aa | 119 | [[summary-section]] |
151b6c2d JH |
120 | The title sentence after the "area:" prefix omits the full stop at the |
121 | end, and its first word is not capitalized unless there is a reason to | |
122 | capitalize it other than because it is the first word in the sentence. | |
123 | E.g. "doc: clarify...", not "doc: Clarify...", or "githooks.txt: | |
124 | improve...", not "githooks.txt: Improve...". But "refs: HEAD is also | |
125 | treated as a ref" is correct, as we spell `HEAD` in all caps even when | |
126 | it appears in the middle of a sentence. | |
2ee00567 | 127 | |
049e64aa | 128 | [[meaningful-message]] |
7d5bf87b JH |
129 | The body should provide a meaningful commit message, which: |
130 | ||
049e64aa | 131 | . explains the problem the change tries to solve, i.e. what is wrong |
132 | with the current code without the change. | |
7d5bf87b | 133 | |
049e64aa | 134 | . justifies the way the change solves the problem, i.e. why the |
135 | result with the change is better. | |
7d5bf87b | 136 | |
049e64aa | 137 | . alternate solutions considered but discarded, if any. |
7d5bf87b | 138 | |
049e64aa | 139 | [[imperative-mood]] |
7d5bf87b JH |
140 | Describe your changes in imperative mood, e.g. "make xyzzy do frotz" |
141 | instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy | |
142 | to do frotz", as if you are giving orders to the codebase to change | |
01e60a9a | 143 | its behavior. Try to make sure your explanation can be understood |
7d5bf87b JH |
144 | without external resources. Instead of giving a URL to a mailing list |
145 | archive, summarize the relevant points of the discussion. | |
146 | ||
049e64aa | 147 | [[commit-reference]] |
175d38ca | 148 | If you want to reference a previous commit in the history of a stable |
fb2ffa77 | 149 | branch, use the format "abbreviated hash (subject, date)", like this: |
4369523b | 150 | |
049e64aa | 151 | .... |
fb2ffa77 | 152 | Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30) |
049e64aa | 153 | noticed that ... |
154 | .... | |
4369523b BB |
155 | |
156 | The "Copy commit summary" command of gitk can be used to obtain this | |
fb2ffa77 DL |
157 | format (with the subject enclosed in a pair of double-quotes), or this |
158 | invocation of `git show`: | |
175d38ca | 159 | |
049e64aa | 160 | .... |
3798149a DL |
161 | git show -s --pretty=reference <commit> |
162 | .... | |
163 | ||
164 | or, on an older version of Git without support for --pretty=reference: | |
165 | ||
049e64aa | 166 | .... |
fb2ffa77 | 167 | git show -s --date=short --pretty='format:%h (%s, %ad)' <commit> |
049e64aa | 168 | .... |
7d5bf87b | 169 | |
049e64aa | 170 | [[git-tools]] |
171 | === Generate your patch using Git tools out of your commits. | |
45d2b286 | 172 | |
2de9b711 | 173 | Git based diff tools generate unidiff which is the preferred format. |
45d2b286 | 174 | |
049e64aa | 175 | You do not have to be afraid to use `-M` option to `git diff` or |
176 | `git format-patch`, if your patch involves file renames. The | |
31408251 JH |
177 | receiving end can handle them just fine. |
178 | ||
049e64aa | 179 | [[review-patch]] |
7d5bf87b JH |
180 | Please make sure your patch does not add commented out debugging code, |
181 | or include any extra files which do not relate to what your patch | |
182 | is trying to achieve. Make sure to review | |
31408251 | 183 | your patch after generating it, to ensure accuracy. Before |
049e64aa | 184 | sending out, please make sure it cleanly applies to the `master` |
45d2b286 JH |
185 | branch head. If you are preparing a work based on "next" branch, |
186 | that is fine, but please mark it as such. | |
31408251 | 187 | |
049e64aa | 188 | [[send-patches]] |
189 | === Sending your patches. | |
31408251 | 190 | |
2a00502b TG |
191 | :security-ml: footnoteref:[security-ml,The Git Security mailing list: git-security@googlegroups.com] |
192 | ||
193 | Before sending any patches, please note that patches that may be | |
194 | security relevant should be submitted privately to the Git Security | |
195 | mailing list{security-ml}, instead of the public mailing list. | |
196 | ||
b25c4699 JH |
197 | Learn to use format-patch and send-email if possible. These commands |
198 | are optimized for the workflow of sending patches, avoiding many ways | |
199 | your existing e-mail client that is optimized for "multipart/*" mime | |
200 | type e-mails to corrupt and render your patches unusable. | |
201 | ||
2de9b711 | 202 | People on the Git mailing list need to be able to read and |
31408251 JH |
203 | comment on the changes you are submitting. It is important for |
204 | a developer to be able to "quote" your changes, using standard | |
205 | e-mail tools, so that they may comment on specific portions of | |
eaa6c987 RS |
206 | your code. For this reason, each patch should be submitted |
207 | "inline" in a separate message. | |
208 | ||
209 | Multiple related patches should be grouped into their own e-mail | |
210 | thread to help readers find all parts of the series. To that end, | |
211 | send them as replies to either an additional "cover letter" message | |
212 | (see below), the first patch, or the respective preceding patch. | |
213 | ||
214 | If your log message (including your name on the | |
3abd4a67 | 215 | `Signed-off-by` trailer) is not writable in ASCII, make sure that |
7d5bf87b JH |
216 | you send off a message in the correct encoding. |
217 | ||
218 | WARNING: Be wary of your MUAs word-wrap | |
45d2b286 JH |
219 | corrupting your patch. Do not cut-n-paste your patch; you can |
220 | lose tabs that way if you are not careful. | |
31408251 | 221 | |
45d2b286 | 222 | It is a common convention to prefix your subject line with |
31408251 | 223 | [PATCH]. This lets people easily distinguish patches from other |
f6be7edc AD |
224 | e-mail discussions. Use of markers in addition to PATCH within |
225 | the brackets to describe the nature of the patch is also | |
226 | encouraged. E.g. [RFC PATCH] (where RFC stands for "request for | |
227 | comments") is often used to indicate a patch needs further | |
228 | discussion before being accepted, [PATCH v2], [PATCH v3] etc. | |
229 | are often seen when you are sending an update to what you have | |
230 | previously sent. | |
231 | ||
1a5f2e44 | 232 | The `git format-patch` command follows the best current practice to |
31408251 JH |
233 | format the body of an e-mail message. At the beginning of the |
234 | patch should come your commit message, ending with the | |
3abd4a67 | 235 | `Signed-off-by` trailers, and a line that consists of three dashes, |
31408251 JH |
236 | followed by the diffstat information and the patch itself. If |
237 | you are forwarding a patch from somebody else, optionally, at | |
238 | the beginning of the e-mail message just before the commit | |
239 | message starts, you can put a "From: " line to name that person. | |
f6be7edc AD |
240 | To change the default "[PATCH]" in the subject to "[<text>]", use |
241 | `git format-patch --subject-prefix=<text>`. As a shortcut, you | |
242 | can use `--rfc` instead of `--subject-prefix="RFC PATCH"`, or | |
243 | `-v <n>` instead of `--subject-prefix="PATCH v<n>"`. | |
31408251 JH |
244 | |
245 | You often want to add additional explanation about the patch, | |
246 | other than the commit message itself. Place such "cover letter" | |
86010993 ES |
247 | material between the three-dash line and the diffstat. For |
248 | patches requiring multiple iterations of review and discussion, | |
249 | an explanation of changes between each iteration can be kept in | |
250 | Git-notes and inserted automatically following the three-dash | |
251 | line via `git format-patch --notes`. | |
31408251 | 252 | |
049e64aa | 253 | [[attachment]] |
31408251 | 254 | Do not attach the patch as a MIME attachment, compressed or not. |
e30b217b JH |
255 | Do not let your e-mail client send quoted-printable. Do not let |
256 | your e-mail client send format=flowed which would destroy | |
257 | whitespaces in your patches. Many | |
31408251 JH |
258 | popular e-mail applications will not always transmit a MIME |
259 | attachment as plain text, making it impossible to comment on | |
260 | your code. A MIME attachment also takes a bit more time to | |
261 | process. This does not decrease the likelihood of your | |
262 | MIME-attached change being accepted, but it makes it more likely | |
263 | that it will be postponed. | |
264 | ||
265 | Exception: If your mailer is mangling patches then someone may ask | |
9847f7e0 | 266 | you to re-send them using MIME, that is OK. |
31408251 | 267 | |
049e64aa | 268 | [[pgp-signature]] |
eafd5d94 CW |
269 | Do not PGP sign your patch. Most likely, your maintainer or other people on the |
270 | list would not have your PGP key and would not bother obtaining it anyway. | |
271 | Your patch is not judged by who you are; a good patch from an unknown origin | |
272 | has a far better chance of being accepted than a patch from a known, respected | |
273 | origin that is done poorly or does incorrect things. | |
9847f7e0 JH |
274 | |
275 | If you really really really really want to do a PGP signed | |
276 | patch, format it as "multipart/signed", not a text/plain message | |
049e64aa | 277 | that starts with `-----BEGIN PGP SIGNED MESSAGE-----`. That is |
9847f7e0 JH |
278 | not a text/plain, it's something else. |
279 | ||
2a00502b TG |
280 | :security-ml-ref: footnoteref:[security-ml] |
281 | ||
282 | As mentioned at the beginning of the section, patches that may be | |
283 | security relevant should not be submitted to the public mailing list | |
284 | mentioned below, but should instead be sent privately to the Git | |
285 | Security mailing list{security-ml-ref}. | |
286 | ||
7d5bf87b | 287 | Send your patch with "To:" set to the mailing list, with "cc:" listing |
92a5dbbc TG |
288 | people who are involved in the area you are touching (the `git |
289 | contacts` command in `contrib/contacts/` can help to | |
7d5bf87b | 290 | identify them), to solicit comments and reviews. |
04d24455 | 291 | |
a27cd1ab TG |
292 | :current-maintainer: footnote:[The current maintainer: gitster@pobox.com] |
293 | :git-ml: footnote:[The mailing list: git@vger.kernel.org] | |
049e64aa | 294 | |
7d5bf87b | 295 | After the list reached a consensus that it is a good idea to apply the |
d95b192e JH |
296 | patch, re-send it with "To:" set to the maintainer{current-maintainer} |
297 | and "cc:" the list{git-ml} for inclusion. This is especially relevant | |
298 | when the maintainer did not heavily participate in the discussion and | |
299 | instead left the review to trusted others. | |
31408251 | 300 | |
049e64aa | 301 | Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and |
302 | `Tested-by:` lines as necessary to credit people who helped your | |
d95b192e | 303 | patch, and "cc:" them when sending such a final version for inclusion. |
04d24455 | 304 | |
049e64aa | 305 | [[sign-off]] |
3abd4a67 | 306 | === Certify your work by adding your `Signed-off-by` trailer |
31408251 | 307 | |
a650fa74 JH |
308 | To improve tracking of who did what, we ask you to certify that you |
309 | wrote the patch or have the right to pass it on under the same license | |
310 | as ours, by "signing off" your patch. Without sign-off, we cannot | |
311 | accept your patches. | |
31408251 | 312 | |
0454986e | 313 | If (and only if) you certify the below D-C-O: |
31408251 | 314 | |
049e64aa | 315 | [[dco]] |
316 | .Developer's Certificate of Origin 1.1 | |
317 | ____ | |
318 | By making a contribution to this project, I certify that: | |
319 | ||
320 | a. The contribution was created in whole or in part by me and I | |
321 | have the right to submit it under the open source license | |
322 | indicated in the file; or | |
323 | ||
324 | b. The contribution is based upon previous work that, to the best | |
325 | of my knowledge, is covered under an appropriate open source | |
326 | license and I have the right under that license to submit that | |
327 | work with modifications, whether created in whole or in part | |
328 | by me, under the same open source license (unless I am | |
329 | permitted to submit under a different license), as indicated | |
330 | in the file; or | |
331 | ||
332 | c. The contribution was provided directly to me by some other | |
333 | person who certified (a), (b) or (c) and I have not modified | |
334 | it. | |
335 | ||
336 | d. I understand and agree that this project and the contribution | |
337 | are public and that a record of the contribution (including all | |
338 | personal information I submit with it, including my sign-off) is | |
339 | maintained indefinitely and may be redistributed consistent with | |
340 | this project or the open source license(s) involved. | |
341 | ____ | |
31408251 | 342 | |
a650fa74 JH |
343 | you add a "Signed-off-by" trailer to your commit, that looks like |
344 | this: | |
31408251 | 345 | |
049e64aa | 346 | .... |
347 | Signed-off-by: Random J Developer <random@developer.example.org> | |
348 | .... | |
31408251 | 349 | |
a650fa74 JH |
350 | This line can be added by Git if you run the git-commit command with |
351 | the -s option. | |
69945602 | 352 | |
3abd4a67 | 353 | Notice that you can place your own `Signed-off-by` trailer when |
c11c3b56 JH |
354 | forwarding somebody else's patch with the above rules for |
355 | D-C-O. Indeed you are encouraged to do so. Do not forget to | |
356 | place an in-body "From: " line at the beginning to properly attribute | |
357 | the change to its true author (see (2) above). | |
358 | ||
a650fa74 JH |
359 | This procedure originally came from the Linux kernel project, so our |
360 | rule is quite similar to theirs, but what exactly it means to sign-off | |
361 | your patch differs from project to project, so it may be different | |
362 | from that of the project you are accustomed to. | |
363 | ||
049e64aa | 364 | [[real-name]] |
3abd4a67 | 365 | Also notice that a real name is used in the `Signed-off-by` trailer. Please |
67275247 MV |
366 | don't hide your real name. |
367 | ||
049e64aa | 368 | [[commit-trailers]] |
95b7a41a RR |
369 | If you like, you can put extra tags at the end: |
370 | ||
049e64aa | 371 | . `Reported-by:` is used to credit someone who found the bug that |
372 | the patch attempts to fix. | |
373 | . `Acked-by:` says that the person who is more familiar with the area | |
374 | the patch attempts to modify liked the patch. | |
375 | . `Reviewed-by:`, unlike the other tags, can only be offered by the | |
376 | reviewer and means that she is completely satisfied that the patch | |
377 | is ready for application. It is usually offered only after a | |
378 | detailed review. | |
379 | . `Tested-by:` is used to indicate that the person applied the patch | |
380 | and found it to have the desired effect. | |
95b7a41a RR |
381 | |
382 | You can also create your own tag or use one that's in common usage | |
383 | such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:". | |
9740d289 | 384 | |
049e64aa | 385 | == Subsystems with dedicated maintainers |
e6da8ee8 JH |
386 | |
387 | Some parts of the system have dedicated maintainers with their own | |
388 | repositories. | |
389 | ||
253bfe49 | 390 | - `git-gui/` comes from git-gui project, maintained by Pratyush Yadav: |
e6da8ee8 | 391 | |
253bfe49 | 392 | https://github.com/prati0100/git-gui.git |
e6da8ee8 | 393 | |
68ed71b5 | 394 | - `gitk-git/` comes from Paul Mackerras's gitk project: |
e6da8ee8 | 395 | |
049e64aa | 396 | git://ozlabs.org/~paulus/gitk |
e6da8ee8 | 397 | |
68ed71b5 | 398 | - `po/` comes from the localization coordinator, Jiang Xin: |
e6da8ee8 JH |
399 | |
400 | https://github.com/git-l10n/git-po/ | |
401 | ||
402 | Patches to these parts should be based on their trees. | |
403 | ||
049e64aa | 404 | [[patch-flow]] |
405 | == An ideal patch flow | |
a941fb4a JH |
406 | |
407 | Here is an ideal patch flow for this project the current maintainer | |
408 | suggests to the contributors: | |
409 | ||
049e64aa | 410 | . You come up with an itch. You code it up. |
a941fb4a | 411 | |
049e64aa | 412 | . Send it to the list and cc people who may need to know about |
413 | the change. | |
414 | + | |
415 | The people who may need to know are the ones whose code you | |
416 | are butchering. These people happen to be the ones who are | |
417 | most likely to be knowledgeable enough to help you, but | |
418 | they have no obligation to help you (i.e. you ask for help, | |
419 | don't demand). +git log -p {litdd} _$area_you_are_modifying_+ would | |
420 | help you find out who they are. | |
a941fb4a | 421 | |
049e64aa | 422 | . You get comments and suggestions for improvements. You may |
928f0ab4 | 423 | even get them in an "on top of your change" patch form. |
a941fb4a | 424 | |
049e64aa | 425 | . Polish, refine, and re-send to the list and the people who |
426 | spend their time to improve your patch. Go back to step (2). | |
a941fb4a | 427 | |
049e64aa | 428 | . The list forms consensus that the last round of your patch is |
429 | good. Send it to the maintainer and cc the list. | |
a941fb4a | 430 | |
049e64aa | 431 | . A topic branch is created with the patch and is merged to `next`, |
432 | and cooked further and eventually graduates to `master`. | |
a941fb4a JH |
433 | |
434 | In any time between the (2)-(3) cycle, the maintainer may pick it up | |
828197de | 435 | from the list and queue it to `seen`, in order to make it easier for |
a941fb4a JH |
436 | people play with it without having to pick up and apply the patch to |
437 | their trees themselves. | |
438 | ||
049e64aa | 439 | [[patch-status]] |
440 | == Know the status of your patch after submission | |
63cb8215 MM |
441 | |
442 | * You can use Git itself to find out when your patch is merged in | |
049e64aa | 443 | master. `git pull --rebase` will automatically skip already-applied |
63cb8215 MM |
444 | patches, and will let you know. This works only if you rebase on top |
445 | of the branch in which your patch has been merged (i.e. it will not | |
828197de | 446 | tell you if your patch is merged in `seen` if you rebase on top of |
63cb8215 MM |
447 | master). |
448 | ||
2de9b711 | 449 | * Read the Git mailing list, the maintainer regularly posts messages |
63cb8215 MM |
450 | entitled "What's cooking in git.git" and "What's in git.git" giving |
451 | the status of various proposed changes. | |
452 | ||
049e64aa | 453 | [[travis]] |
454 | == GitHub-Travis CI hints | |
0e5d028a LS |
455 | |
456 | With an account at GitHub (you can get one for free to work on open | |
457 | source projects), you can use Travis CI to test your changes on Linux, | |
458 | Mac (and hopefully soon Windows). You can find a successful example | |
459 | test build here: https://travis-ci.org/git/git/builds/120473209 | |
460 | ||
461 | Follow these steps for the initial setup: | |
462 | ||
049e64aa | 463 | . Fork https://github.com/git/git to your GitHub account. |
464 | You can find detailed instructions how to fork here: | |
465 | https://help.github.com/articles/fork-a-repo/ | |
0e5d028a | 466 | |
049e64aa | 467 | . Open the Travis CI website: https://travis-ci.org |
0e5d028a | 468 | |
049e64aa | 469 | . Press the "Sign in with GitHub" button. |
0e5d028a | 470 | |
049e64aa | 471 | . Grant Travis CI permissions to access your GitHub account. |
472 | You can find more information about the required permissions here: | |
473 | https://docs.travis-ci.com/user/github-oauth-scopes | |
0e5d028a | 474 | |
049e64aa | 475 | . Open your Travis CI profile page: https://travis-ci.org/profile |
0e5d028a | 476 | |
049e64aa | 477 | . Enable Travis CI builds for your Git fork. |
0e5d028a LS |
478 | |
479 | After the initial setup, Travis CI will run whenever you push new changes | |
480 | to your fork of Git on GitHub. You can monitor the test state of all your | |
049e64aa | 481 | branches here: https://travis-ci.org/__<Your GitHub handle>__/git/branches |
0e5d028a LS |
482 | |
483 | If a branch did not pass all test cases then it is marked with a red | |
484 | cross. In that case you can click on the failing Travis CI job and | |
485 | scroll all the way down in the log. Find the line "<-- Click here to see | |
486 | detailed test output!" and click on the triangle next to the log line | |
487 | number to expand the detailed test output. Here is such a failing | |
488 | example: https://travis-ci.org/git/git/jobs/122676187 | |
489 | ||
490 | Fix the problem and push your fix to your Git fork. This will trigger | |
491 | a new Travis CI build to ensure all tests pass. | |
492 | ||
049e64aa | 493 | [[mua]] |
494 | == MUA specific hints | |
9740d289 JH |
495 | |
496 | Some of patches I receive or pick up from the list share common | |
497 | patterns of breakage. Please make sure your MUA is set up | |
57756161 JN |
498 | properly not to corrupt whitespaces. |
499 | ||
049e64aa | 500 | See the DISCUSSION section of linkgit:git-format-patch[1] for hints on |
57756161 | 501 | checking your patch by mailing it to yourself and applying with |
049e64aa | 502 | linkgit:git-am[1]. |
57756161 JN |
503 | |
504 | While you are at it, check the resulting commit log message from | |
505 | a trial run of applying the patch. If what is in the resulting | |
506 | commit is not exactly what you would want to see, it is very | |
507 | likely that your maintainer would end up hand editing the log | |
508 | message when he applies your patch. Things like "Hi, this is my | |
509 | first patch.\n", if you really want to put in the patch e-mail, | |
510 | should come after the three-dash line that signals the end of the | |
511 | commit message. | |
9847f7e0 | 512 | |
9740d289 | 513 | |
049e64aa | 514 | === Pine |
9740d289 JH |
515 | |
516 | (Johannes Schindelin) | |
517 | ||
049e64aa | 518 | .... |
9740d289 JH |
519 | I don't know how many people still use pine, but for those poor |
520 | souls it may be good to mention that the quell-flowed-text is | |
521 | needed for recent versions. | |
522 | ||
523 | ... the "no-strip-whitespace-before-send" option, too. AFAIK it | |
524 | was introduced in 4.60. | |
049e64aa | 525 | .... |
9740d289 JH |
526 | |
527 | (Linus Torvalds) | |
528 | ||
049e64aa | 529 | .... |
9740d289 JH |
530 | And 4.58 needs at least this. |
531 | ||
9740d289 JH |
532 | diff-tree 8326dd8350be64ac7fc805f6563a1d61ad10d32c (from e886a61f76edf5410573e92e38ce22974f9c40f1) |
533 | Author: Linus Torvalds <torvalds@g5.osdl.org> | |
534 | Date: Mon Aug 15 17:23:51 2005 -0700 | |
535 | ||
536 | Fix pine whitespace-corruption bug | |
537 | ||
538 | There's no excuse for unconditionally removing whitespace from | |
539 | the pico buffers on close. | |
540 | ||
541 | diff --git a/pico/pico.c b/pico/pico.c | |
542 | --- a/pico/pico.c | |
543 | +++ b/pico/pico.c | |
544 | @@ -219,7 +219,9 @@ PICO *pm; | |
a6080a0a JH |
545 | switch(pico_all_done){ /* prepare for/handle final events */ |
546 | case COMP_EXIT : /* already confirmed */ | |
547 | packheader(); | |
9740d289 | 548 | +#if 0 |
a6080a0a | 549 | stripwhitespace(); |
9740d289 | 550 | +#endif |
a6080a0a JH |
551 | c |= COMP_EXIT; |
552 | break; | |
049e64aa | 553 | .... |
9740d289 | 554 | |
1eb446fa JH |
555 | (Daniel Barkalow) |
556 | ||
049e64aa | 557 | .... |
1eb446fa JH |
558 | > A patch to SubmittingPatches, MUA specific help section for |
559 | > users of Pine 4.63 would be very much appreciated. | |
560 | ||
561 | Ah, it looks like a recent version changed the default behavior to do the | |
562 | right thing, and inverted the sense of the configuration option. (Either | |
563 | that or Gentoo did it.) So you need to set the | |
564 | "no-strip-whitespace-before-send" option, unless the option you have is | |
565 | "strip-whitespace-before-send", in which case you should avoid checking | |
566 | it. | |
049e64aa | 567 | .... |
1eb446fa | 568 | |
049e64aa | 569 | === Thunderbird, KMail, GMail |
9740d289 | 570 | |
049e64aa | 571 | See the MUA-SPECIFIC HINTS section of linkgit:git-format-patch[1]. |
e30b217b | 572 | |
049e64aa | 573 | === Gnus |
e30b217b | 574 | |
049e64aa | 575 | "|" in the `*Summary*` buffer can be used to pipe the current |
e30b217b | 576 | message to an external program, and this is a handy way to drive |
049e64aa | 577 | `git am`. However, if the message is MIME encoded, what is |
e30b217b | 578 | piped into the program is the representation you see in your |
049e64aa | 579 | `*Article*` buffer after unwrapping MIME. This is often not what |
e30b217b JH |
580 | you would want for two reasons. It tends to screw up non ASCII |
581 | characters (most notably in people's names), and also | |
049e64aa | 582 | whitespaces (fatal in patches). Running "C-u g" to display the |
583 | message in raw form before using "|" to run the pipe can work | |
e30b217b | 584 | this problem around. |