From: Junio C Hamano Date: Wed, 25 Mar 2015 19:54:23 +0000 (-0700) Subject: Merge branch 'jc/submitting-patches-mention-send-email' X-Git-Tag: v2.4.0-rc0~12 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/cf07d3fe9068acbd0dd15abeab9370f372a6e26d?hp=-c Merge branch 'jc/submitting-patches-mention-send-email' Recommend format-patch and send-email for those who want to submit patches to this project. * jc/submitting-patches-mention-send-email: SubmittingPatches: encourage users to use format-patch and send-email --- cf07d3fe9068acbd0dd15abeab9370f372a6e26d diff --combined Documentation/SubmittingPatches index ef0eeb40cd,38e4ae23a9..98fc4cc1d0 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@@ -57,8 -57,7 +57,8 @@@ change, the approach taken by the chang differs substantially from the prior version, are all good things to have. -Make sure that you have tests for the bug you are fixing. +Make sure that you have tests for the bug you are fixing. See +t/README for guidance. When adding a new feature, make sure that you have new tests to show the feature triggers the new behaviour when it should, and to show the @@@ -136,6 -135,11 +136,11 @@@ that is fine, but please mark it as suc (4) Sending your patches. + Learn to use format-patch and send-email if possible. These commands + are optimized for the workflow of sending patches, avoiding many ways + your existing e-mail client that is optimized for "multipart/*" mime + type e-mails to corrupt and render your patches unusable. + People on the Git mailing list need to be able to read and comment on the changes you are submitting. It is important for a developer to be able to "quote" your changes, using standard @@@ -176,11 -180,8 +181,11 @@@ message starts, you can put a "From: " You often want to add additional explanation about the patch, other than the commit message itself. Place such "cover letter" -material between the three dash lines and the diffstat. Git-notes -can also be inserted using the `--notes` option. +material between the three-dash line and the diffstat. For +patches requiring multiple iterations of review and discussion, +an explanation of changes between each iteration can be kept in +Git-notes and inserted automatically following the three-dash +line via `git format-patch --notes`. Do not attach the patch as a MIME attachment, compressed or not. Do not let your e-mail client send quoted-printable. Do not let @@@ -258,15 -259,15 +263,15 @@@ pretty simple: if you can certify the b person who certified (a), (b) or (c) and I have not modified it. - (d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. + (d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. then you just add a line saying - Signed-off-by: Random J Developer + Signed-off-by: Random J Developer This line can be automatically added by Git if you run the git-commit command with the -s option. @@@ -341,7 -342,7 +346,7 @@@ suggests to the contributors spend their time to improve your patch. Go back to step (2). (4) The list forms consensus that the last round of your patch is - good. Send it to the list and cc the maintainer. + good. Send it to the maintainer and cc the list. (5) A topic branch is created with the patch and is merged to 'next', and cooked further and eventually graduates to 'master'.