SubmittingPatches: discuss reviewers first
No matter how well someone configures their email tooling, understanding who to send the patches to is something that must always be considered. So discuss it first instead of at the end. In the following commit we will clean up the (now redundant) discussion about sending security patches to the Git Security mailing list. Signed-off-by: Linus Arver <linusa@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Linus Arver committed
Apr 18, 2024 at 21:52 UTC
e2663c459710fc6dbf11b614612844d3c15562a1
1 file changed
+34
-32
Documentation/SubmittingPatches
+34
-32
@@ -397,6 +397,40 @@ letter.
397
[[send-patches]]
398
=== Sending your patches.
399
400
+==== Choosing your reviewers
401
+
402
+:security-ml-ref: footnoteref:[security-ml]
403
+
404
+As mentioned at the beginning of the section, patches that may be
405
+security relevant should not be submitted to the public mailing list
406
+mentioned below, but should instead be sent privately to the Git
407
+Security mailing list{security-ml-ref}.
408
+
409
+:contrib-scripts: footnoteref:[contrib-scripts,Scripts under `contrib/` are +
410
+not part of the core `git` binary and must be called directly. Clone the Git +
411
+codebase and run `perl contrib/contacts/git-contacts`.]
412
+
413
+Send your patch with "To:" set to the mailing list, with "cc:" listing
414
+people who are involved in the area you are touching (the `git-contacts`
415
+script in `contrib/contacts/`{contrib-scripts} can help to
416
+identify them), to solicit comments and reviews. Also, when you made
417
+trial merges of your topic to `next` and `seen`, you may have noticed
418
+work by others conflicting with your changes. There is a good possibility
419
+that these people may know the area you are touching well.
420
+
421
+:current-maintainer: footnote:[The current maintainer: gitster@pobox.com]
422
+:git-ml: footnote:[The mailing list: git@vger.kernel.org]
423
+
424
+After the list reached a consensus that it is a good idea to apply the
425
+patch, re-send it with "To:" set to the maintainer{current-maintainer}
426
+and "cc:" the list{git-ml} for inclusion. This is especially relevant
427
+when the maintainer did not heavily participate in the discussion and
428
+instead left the review to trusted others.
429
+
430
+Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and
431
+`Tested-by:` lines as necessary to credit people who helped your
432
+patch, and "cc:" them when sending such a final version for inclusion.
433
+
434
:security-ml: footnoteref:[security-ml,The Git Security mailing list: git-security@googlegroups.com]
435
436
Before sending any patches, please note that patches that may be
@@ -490,38 +524,6 @@ patch, format it as "multipart/signed", not a text/plain message
524
that starts with `-----BEGIN PGP SIGNED MESSAGE-----`. That is
525
not a text/plain, it's something else.
526
493
-:security-ml-ref: footnoteref:[security-ml]
494
-
495
-As mentioned at the beginning of the section, patches that may be
496
-security relevant should not be submitted to the public mailing list
497
-mentioned below, but should instead be sent privately to the Git
498
-Security mailing list{security-ml-ref}.
499
-
500
-:contrib-scripts: footnoteref:[contrib-scripts,Scripts under `contrib/` are +
501
-not part of the core `git` binary and must be called directly. Clone the Git +
502
-codebase and run `perl contrib/contacts/git-contacts`.]
503
-
504
-Send your patch with "To:" set to the mailing list, with "cc:" listing
505
-people who are involved in the area you are touching (the `git-contacts`
506
-script in `contrib/contacts/`{contrib-scripts} can help to
507
-identify them), to solicit comments and reviews. Also, when you made
508
-trial merges of your topic to `next` and `seen`, you may have noticed
509
-work by others conflicting with your changes. There is a good possibility
510
-that these people may know the area you are touching well.
511
-
512
-:current-maintainer: footnote:[The current maintainer: gitster@pobox.com]
513
-:git-ml: footnote:[The mailing list: git@vger.kernel.org]
514
-
515
-After the list reached a consensus that it is a good idea to apply the
516
-patch, re-send it with "To:" set to the maintainer{current-maintainer}
517
-and "cc:" the list{git-ml} for inclusion. This is especially relevant
518
-when the maintainer did not heavily participate in the discussion and
519
-instead left the review to trusted others.
520
-
521
-Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and
522
-`Tested-by:` lines as necessary to credit people who helped your
523
-patch, and "cc:" them when sending such a final version for inclusion.
524
-
527
== Subsystems with dedicated maintainers
528
529
Some parts of the system have dedicated maintainers with their own